Package org.linuxforhealth.fhir.model.resource

Class Immunization.ProtocolApplied.Builder

    • Method Detail

      • id

        public Immunization.ProtocolApplied.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 Immunization.ProtocolApplied.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 Immunization.ProtocolApplied.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 Immunization.ProtocolApplied.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 Immunization.ProtocolApplied.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

      • series

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

      • authority

        public Immunization.ProtocolApplied.Builder authority​(Reference authority)
        Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

        Allowed resource types for this reference:

        Parameters:
        authority - Who is responsible for publishing the recommendations
        Returns:
        A reference to this Builder instance

      • targetDisease

        public Immunization.ProtocolApplied.Builder targetDisease​(CodeableConcept... targetDisease)
        The vaccine preventable disease the dose is being administered against.

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

        Parameters:
        targetDisease - Vaccine preventatable disease being targetted
        Returns:
        A reference to this Builder instance

      • targetDisease

        public Immunization.ProtocolApplied.Builder targetDisease​(java.util.Collection<CodeableConcept> targetDisease)
        The vaccine preventable disease the dose is being administered against.

        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:
        targetDisease - Vaccine preventatable disease being targetted
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • doseNumber

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

        This element is required.

        Parameters:
        doseNumber - Dose number within series
        Returns:
        A reference to this Builder instance
        See Also:
        doseNumber(Element)

      • doseNumber

        public Immunization.ProtocolApplied.Builder doseNumber​(Element doseNumber)
        Nominal position in a series.

        This element is required.

        This is a choice element with the following allowed types:

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

      • seriesDoses

        public Immunization.ProtocolApplied.Builder seriesDoses​(java.lang.String seriesDoses)
        Convenience method for setting seriesDoses with choice type String.
        Parameters:
        seriesDoses - Recommended number of doses for immunity
        Returns:
        A reference to this Builder instance
        See Also:
        seriesDoses(Element)

      • seriesDoses

        public Immunization.ProtocolApplied.Builder seriesDoses​(Element seriesDoses)
        The recommended number of doses to achieve immunity.

        This is a choice element with the following allowed types:

        Parameters:
        seriesDoses - Recommended number of doses for immunity
        Returns:
        A reference to this Builder instance