Package com.babylonhealth.lit.hl7_java.builders

Class ImmunizationBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.hl7.IMMUNIZATION_STATUS status,
            com.babylonhealth.lit.core.model.Reference patient,
            com.babylonhealth.lit.core.model.CodeableConcept vaccineCode,
            @NonNull
            @NonNull Unions.ChoiceDateTimeOrString occurrence)
        Required fields for Immunization
        Parameters:
        status - - Indicates the current status of the immunization event.
        patient - - The patient who either received or did not receive the immunization.
        vaccineCode - - Vaccine that was administered or was to be administered.
        occurrence - - Date vaccine administered or was to be administered. Field is a 'choice' field. Type should be one of FHIRDateTime, String. To pass the value in, wrap with one of the ImmunizationBuilder.occurrence static methods

    • Method Detail

      • withId

        public ImmunizationBuilder.Impl withId​(@NonNull
                                       @NonNull java.lang.String id)
        Parameters:
        id - - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • withMeta

        public ImmunizationBuilder.Impl withMeta​(@NonNull
                                         @NonNull com.babylonhealth.lit.core.model.Meta meta)
        Parameters:
        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.

      • withMeta

        public ImmunizationBuilder.Impl withMeta​(@NonNull
                                         @NonNull com.babylonhealth.lit.core_java.builders.MetaBuilder meta)

      • withText

        public ImmunizationBuilder.Impl withText​(@NonNull
                                         @NonNull com.babylonhealth.lit.hl7.model.Narrative text)
        Parameters:
        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.

      • withSite

        public ImmunizationBuilder.Impl withSite​(@NonNull
                                         @NonNull com.babylonhealth.lit.core.model.CodeableConcept site)
        Parameters:
        site - - Body site where vaccine was administered.

      • withSite

        public ImmunizationBuilder.Impl withSite​(@NonNull
                                         @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder site)

      • withNote

        public ImmunizationBuilder.Impl withNote​(@NonNull
                                         @NonNull com.babylonhealth.lit.core.model.Annotation... note)
        Parameters:
        note - - Extra information about the immunization that is not conveyed by the other attributes.

      • withNote

        public ImmunizationBuilder.Impl withNote​(@NonNull
                                         @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Annotation> note)
        Parameters:
        note - - Extra information about the immunization that is not conveyed by the other attributes.

      • withNote

        public ImmunizationBuilder.Impl withNote​(@NonNull
                                         @NonNull com.babylonhealth.lit.core_java.builders.AnnotationBuilder... note)

      • withRoute

        public ImmunizationBuilder.Impl withRoute​(@NonNull
                                          @NonNull com.babylonhealth.lit.core.model.CodeableConcept route)
        Parameters:
        route - - The path by which the vaccine product is taken into the body.

      • withRoute

        public ImmunizationBuilder.Impl withRoute​(@NonNull
                                          @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder route)

      • withLanguage

        public ImmunizationBuilder.Impl withLanguage​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.LANGUAGES language)
        Parameters:
        language - - The base language in which the resource is written.

      • withRecorded

        public ImmunizationBuilder.Impl withRecorded​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.FHIRDateTime recorded)
        Parameters:
        recorded - - The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

      • withLocation

        public ImmunizationBuilder.Impl withLocation​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.Reference location)
        Parameters:
        location - - The service delivery location where the vaccine administration occurred.

      • withLocation

        public ImmunizationBuilder.Impl withLocation​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder location)

      • withContained

        public ImmunizationBuilder.Impl withContained​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.Resource... contained)
        Parameters:
        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.

      • withContained

        public ImmunizationBuilder.Impl withContained​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Resource> contained)
        Parameters:
        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.

      • withContained

        public ImmunizationBuilder.Impl withContained​(@NonNull
                                              @NonNull com.babylonhealth.lit.core_java.builders.ResourceBuilder... contained)

      • withExtension

        public ImmunizationBuilder.Impl withExtension​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.Extension... extension)
        Parameters:
        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.

      • withExtension

        public ImmunizationBuilder.Impl withExtension​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> extension)
        Parameters:
        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.

      • withExtension

        public ImmunizationBuilder.Impl withExtension​(@NonNull
                                              @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withEncounter

        public ImmunizationBuilder.Impl withEncounter​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.Reference encounter)
        Parameters:
        encounter - - The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

      • withEncounter

        public ImmunizationBuilder.Impl withEncounter​(@NonNull
                                              @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder encounter)

      • withLotNumber

        public ImmunizationBuilder.Impl withLotNumber​(@NonNull
                                              @NonNull java.lang.String lotNumber)
        Parameters:
        lotNumber - - Lot number of the vaccine product.

      • withIdentifier

        public ImmunizationBuilder.Impl withIdentifier​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.model.Identifier... identifier)
        Parameters:
        identifier - - A unique identifier assigned to this immunization record.

      • withIdentifier

        public ImmunizationBuilder.Impl withIdentifier​(@NonNull
                                               @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Identifier> identifier)
        Parameters:
        identifier - - A unique identifier assigned to this immunization record.

      • withIdentifier

        public ImmunizationBuilder.Impl withIdentifier​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.IdentifierBuilder... identifier)

      • withReasonCode

        public ImmunizationBuilder.Impl withReasonCode​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.model.CodeableConcept... reasonCode)
        Parameters:
        reasonCode - - Reasons why the vaccine was administered.

      • withReasonCode

        public ImmunizationBuilder.Impl withReasonCode​(@NonNull
                                               @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> reasonCode)
        Parameters:
        reasonCode - - Reasons why the vaccine was administered.

      • withReasonCode

        public ImmunizationBuilder.Impl withReasonCode​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... reasonCode)

      • withIsSubpotent

        public ImmunizationBuilder.Impl withIsSubpotent​(@NonNull
                                                @NonNull java.lang.Boolean isSubpotent)
        Parameters:
        isSubpotent - - Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

      • withStatusReason

        public ImmunizationBuilder.Impl withStatusReason​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core.model.CodeableConcept statusReason)
        Parameters:
        statusReason - - Indicates the reason the immunization event was not performed.

      • withStatusReason

        public ImmunizationBuilder.Impl withStatusReason​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder statusReason)

      • withReportOrigin

        public ImmunizationBuilder.Impl withReportOrigin​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core.model.CodeableConcept reportOrigin)
        Parameters:
        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.

      • withReportOrigin

        public ImmunizationBuilder.Impl withReportOrigin​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder reportOrigin)

      • withManufacturer

        public ImmunizationBuilder.Impl withManufacturer​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core.model.Reference manufacturer)
        Parameters:
        manufacturer - - Name of vaccine manufacturer.

      • withManufacturer

        public ImmunizationBuilder.Impl withManufacturer​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder manufacturer)

      • withDoseQuantity

        public ImmunizationBuilder.Impl withDoseQuantity​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core.model.Quantity doseQuantity)
        Parameters:
        doseQuantity - - The quantity of vaccine product that was administered.

      • withDoseQuantity

        public ImmunizationBuilder.Impl withDoseQuantity​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core_java.builders.QuantityBuilder doseQuantity)

      • withImplicitRules

        public ImmunizationBuilder.Impl withImplicitRules​(@NonNull
                                                  @NonNull java.lang.String implicitRules)
        Parameters:
        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.

      • withPrimarySource

        public ImmunizationBuilder.Impl withPrimarySource​(@NonNull
                                                  @NonNull java.lang.Boolean primarySource)
        Parameters:
        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.

      • withFundingSource

        public ImmunizationBuilder.Impl withFundingSource​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core.model.CodeableConcept fundingSource)
        Parameters:
        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).

      • withFundingSource

        public ImmunizationBuilder.Impl withFundingSource​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder fundingSource)

      • withExpirationDate

        public ImmunizationBuilder.Impl withExpirationDate​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.FHIRDate expirationDate)
        Parameters:
        expirationDate - - Date vaccine batch expires.

      • withReasonReference

        public ImmunizationBuilder.Impl withReasonReference​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core.model.Reference... reasonReference)
        Parameters:
        reasonReference - - Condition, Observation or DiagnosticReport that supports why the immunization was administered.

      • withReasonReference

        public ImmunizationBuilder.Impl withReasonReference​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> reasonReference)
        Parameters:
        reasonReference - - Condition, Observation or DiagnosticReport that supports why the immunization was administered.

      • withReasonReference

        public ImmunizationBuilder.Impl withReasonReference​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... reasonReference)

      • withSubpotentReason

        public ImmunizationBuilder.Impl withSubpotentReason​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core.model.CodeableConcept... subpotentReason)
        Parameters:
        subpotentReason - - Reason why a dose is considered to be subpotent.

      • withSubpotentReason

        public ImmunizationBuilder.Impl withSubpotentReason​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> subpotentReason)
        Parameters:
        subpotentReason - - Reason why a dose is considered to be subpotent.

      • withSubpotentReason

        public ImmunizationBuilder.Impl withSubpotentReason​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... subpotentReason)

      • withModifierExtension

        public ImmunizationBuilder.Impl withModifierExtension​(@NonNull
                                                      @NonNull com.babylonhealth.lit.core.model.Extension... modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public ImmunizationBuilder.Impl withModifierExtension​(@NonNull
                                                      @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public ImmunizationBuilder.Impl withModifierExtension​(@NonNull
                                                      @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withProgramEligibility

        public ImmunizationBuilder.Impl withProgramEligibility​(@NonNull
                                                       @NonNull com.babylonhealth.lit.core.model.CodeableConcept... programEligibility)
        Parameters:
        programEligibility - - Indicates a patient's eligibility for a funding program.

      • withProgramEligibility

        public ImmunizationBuilder.Impl withProgramEligibility​(@NonNull
                                                       @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> programEligibility)
        Parameters:
        programEligibility - - Indicates a patient's eligibility for a funding program.

      • withProgramEligibility

        public ImmunizationBuilder.Impl withProgramEligibility​(@NonNull
                                                       @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... programEligibility)

      • withReaction

        public ImmunizationBuilder.Impl withReaction​(@NonNull
                                             @NonNull com.babylonhealth.lit.hl7.model.Immunization.Reaction... reaction)
        Parameters:
        reaction - - Categorical data indicating that an adverse event is associated in time to an immunization.

      • withReaction

        public ImmunizationBuilder.Impl withReaction​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.Immunization.Reaction> reaction)
        Parameters:
        reaction - - Categorical data indicating that an adverse event is associated in time to an immunization.

      • withPerformer

        public ImmunizationBuilder.Impl withPerformer​(@NonNull
                                              @NonNull com.babylonhealth.lit.hl7.model.Immunization.Performer... performer)
        Parameters:
        performer - - Indicates who performed the immunization event.

      • withPerformer

        public ImmunizationBuilder.Impl withPerformer​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.Immunization.Performer> performer)
        Parameters:
        performer - - Indicates who performed the immunization event.

      • withEducation

        public ImmunizationBuilder.Impl withEducation​(@NonNull
                                              @NonNull com.babylonhealth.lit.hl7.model.Immunization.Education... education)
        Parameters:
        education - - Educational material presented to the patient (or guardian) at the time of vaccine administration.

      • withEducation

        public ImmunizationBuilder.Impl withEducation​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.Immunization.Education> education)
        Parameters:
        education - - Educational material presented to the patient (or guardian) at the time of vaccine administration.

      • withProtocolApplied

        public ImmunizationBuilder.Impl withProtocolApplied​(@NonNull
                                                    @NonNull com.babylonhealth.lit.hl7.model.Immunization.ProtocolApplied... protocolApplied)
        Parameters:
        protocolApplied - - The protocol (set of recommendations) being followed by the provider who administered the dose.

      • withProtocolApplied

        public ImmunizationBuilder.Impl withProtocolApplied​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.Immunization.ProtocolApplied> protocolApplied)
        Parameters:
        protocolApplied - - The protocol (set of recommendations) being followed by the provider who administered the dose.

      • build

        public com.babylonhealth.lit.hl7.model.Immunization build()
        Specified by:
        build in interface DomainResourceBuilder
        Specified by:
        build in interface ImmunizationBuilder
        Specified by:
        build in interface com.babylonhealth.lit.core_java.builders.ResourceBuilder