Package com.babylonhealth.lit.hl7_java.builders

Class ObservationBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.core.model.CodeableConcept code,
            com.babylonhealth.lit.hl7.OBSERVATION_STATUS status)
        Required fields for Observation
        Parameters:
        code - - Describes what was observed. Sometimes this is called the observation "name".
        status - - The status of the result value.

    • Method Detail

      • withId

        public ObservationBuilder.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 ObservationBuilder.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 ObservationBuilder.Impl withMeta​(@NonNull
                                        @NonNull com.babylonhealth.lit.core_java.builders.MetaBuilder meta)

      • withText

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

      • withNote

        public ObservationBuilder.Impl withNote​(@NonNull
                                        @NonNull com.babylonhealth.lit.core.model.Annotation... note)
        Parameters:
        note - - Comments about the observation or the results.

      • withNote

        public ObservationBuilder.Impl withNote​(@NonNull
                                        @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Annotation> note)
        Parameters:
        note - - Comments about the observation or the results.

      • withNote

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

      • withFocus

        public ObservationBuilder.Impl withFocus​(@NonNull
                                         @NonNull com.babylonhealth.lit.core.model.Reference... focus)
        Parameters:
        focus - - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

      • withFocus

        public ObservationBuilder.Impl withFocus​(@NonNull
                                         @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> focus)
        Parameters:
        focus - - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

      • withFocus

        public ObservationBuilder.Impl withFocus​(@NonNull
                                         @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... focus)

      • withPartOf

        public ObservationBuilder.Impl withPartOf​(@NonNull
                                          @NonNull com.babylonhealth.lit.core.model.Reference... partOf)
        Parameters:
        partOf - - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

      • withPartOf

        public ObservationBuilder.Impl withPartOf​(@NonNull
                                          @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> partOf)
        Parameters:
        partOf - - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

      • withPartOf

        public ObservationBuilder.Impl withPartOf​(@NonNull
                                          @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... partOf)

      • withIssued

        public ObservationBuilder.Impl withIssued​(@NonNull
                                          @NonNull java.time.ZonedDateTime issued)
        Parameters:
        issued - - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

      • withMethod

        public ObservationBuilder.Impl withMethod​(@NonNull
                                          @NonNull com.babylonhealth.lit.core.model.CodeableConcept method)
        Parameters:
        method - - Indicates the mechanism used to perform the observation.

      • withMethod

        public ObservationBuilder.Impl withMethod​(@NonNull
                                          @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder method)

      • withDevice

        public ObservationBuilder.Impl withDevice​(@NonNull
                                          @NonNull com.babylonhealth.lit.core.model.Reference device)
        Parameters:
        device - - The device used to generate the observation data.

      • withDevice

        public ObservationBuilder.Impl withDevice​(@NonNull
                                          @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder device)

      • withBasedOn

        public ObservationBuilder.Impl withBasedOn​(@NonNull
                                           @NonNull com.babylonhealth.lit.core.model.Reference... basedOn)
        Parameters:
        basedOn - - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

      • withBasedOn

        public ObservationBuilder.Impl withBasedOn​(@NonNull
                                           @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> basedOn)
        Parameters:
        basedOn - - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

      • withBasedOn

        public ObservationBuilder.Impl withBasedOn​(@NonNull
                                           @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... basedOn)

      • withSubject

        public ObservationBuilder.Impl withSubject​(@NonNull
                                           @NonNull com.babylonhealth.lit.core.model.Reference subject)
        Parameters:
        subject - - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.

      • withSubject

        public ObservationBuilder.Impl withSubject​(@NonNull
                                           @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder subject)

      • withLanguage

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

      • withCategory

        public ObservationBuilder.Impl withCategory​(@NonNull
                                            @NonNull com.babylonhealth.lit.core.model.CodeableConcept... category)
        Parameters:
        category - - A code that classifies the general type of observation being made.

      • withCategory

        public ObservationBuilder.Impl withCategory​(@NonNull
                                            @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> category)
        Parameters:
        category - - A code that classifies the general type of observation being made.

      • withCategory

        public ObservationBuilder.Impl withCategory​(@NonNull
                                            @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... category)

      • withValue

        public ObservationBuilder.Impl withValue​(@NonNull
                                         @NonNull Unions.Choice02118820890 value)
        Parameters:
        value - - The information determined as a result of making the observation, if the information has a simple value. Field is a 'choice' field. Type should be one of Boolean, CodeableConcept, FHIRDateTime, Integer, LocalTime, Period, Quantity, Range, Ratio, SampledData, String. To pass the value in, wrap with one of the ObservationBuilder.value static methods

      • withBodySite

        public ObservationBuilder.Impl withBodySite​(@NonNull
                                            @NonNull com.babylonhealth.lit.core.model.CodeableConcept bodySite)
        Parameters:
        bodySite - - Indicates the site on the subject's body where the observation was made (i.e. the target site).

      • withBodySite

        public ObservationBuilder.Impl withBodySite​(@NonNull
                                            @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder bodySite)

      • withSpecimen

        public ObservationBuilder.Impl withSpecimen​(@NonNull
                                            @NonNull com.babylonhealth.lit.core.model.Reference specimen)
        Parameters:
        specimen - - The specimen that was used when this observation was made.

      • withSpecimen

        public ObservationBuilder.Impl withSpecimen​(@NonNull
                                            @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder specimen)

      • withContained

        public ObservationBuilder.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 ObservationBuilder.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 ObservationBuilder.Impl withContained​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.ResourceBuilder... contained)

      • withExtension

        public ObservationBuilder.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 ObservationBuilder.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 ObservationBuilder.Impl withExtension​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withEncounter

        public ObservationBuilder.Impl withEncounter​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.Reference encounter)
        Parameters:
        encounter - - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

      • withEncounter

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

      • withPerformer

        public ObservationBuilder.Impl withPerformer​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.Reference... performer)
        Parameters:
        performer - - Who was responsible for asserting the observed value as "true".

      • withPerformer

        public ObservationBuilder.Impl withPerformer​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> performer)
        Parameters:
        performer - - Who was responsible for asserting the observed value as "true".

      • withPerformer

        public ObservationBuilder.Impl withPerformer​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... performer)

      • withHasMember

        public ObservationBuilder.Impl withHasMember​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.Reference... hasMember)
        Parameters:
        hasMember - - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

      • withHasMember

        public ObservationBuilder.Impl withHasMember​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> hasMember)
        Parameters:
        hasMember - - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

      • withHasMember

        public ObservationBuilder.Impl withHasMember​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... hasMember)

      • withIdentifier

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

      • withIdentifier

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

      • withIdentifier

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

      • withDerivedFrom

        public ObservationBuilder.Impl withDerivedFrom​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.model.Reference... derivedFrom)
        Parameters:
        derivedFrom - - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

      • withDerivedFrom

        public ObservationBuilder.Impl withDerivedFrom​(@NonNull
                                               @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> derivedFrom)
        Parameters:
        derivedFrom - - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

      • withDerivedFrom

        public ObservationBuilder.Impl withDerivedFrom​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... derivedFrom)

      • withEffective

        public ObservationBuilder.Impl withEffective​(@NonNull
                                             @NonNull Unions.Choice00107722725 effective)
        Parameters:
        effective - - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. Field is a 'choice' field. Type should be one of FHIRDateTime, Period, Timing, ZonedDateTime. To pass the value in, wrap with one of the ObservationBuilder.effective static methods

      • withImplicitRules

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

      • withInterpretation

        public ObservationBuilder.Impl withInterpretation​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core.model.CodeableConcept... interpretation)
        Parameters:
        interpretation - - A categorical assessment of an observation value. For example, high, low, normal.

      • withInterpretation

        public ObservationBuilder.Impl withInterpretation​(@NonNull
                                                  @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> interpretation)
        Parameters:
        interpretation - - A categorical assessment of an observation value. For example, high, low, normal.

      • withInterpretation

        public ObservationBuilder.Impl withInterpretation​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... interpretation)

      • withDataAbsentReason

        public ObservationBuilder.Impl withDataAbsentReason​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core.model.CodeableConcept dataAbsentReason)
        Parameters:
        dataAbsentReason - - Provides a reason why the expected value in the element Observation.value[x] is missing.

      • withDataAbsentReason

        public ObservationBuilder.Impl withDataAbsentReason​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder dataAbsentReason)

      • withModifierExtension

        public ObservationBuilder.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 ObservationBuilder.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 ObservationBuilder.Impl withModifierExtension​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withComponent

        public ObservationBuilder.Impl withComponent​(@NonNull
                                             @NonNull com.babylonhealth.lit.hl7.model.Observation.Component... component)
        Parameters:
        component - - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

      • withComponent

        public ObservationBuilder.Impl withComponent​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.Observation.Component> component)
        Parameters:
        component - - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

      • withReferenceRange

        public ObservationBuilder.Impl withReferenceRange​(@NonNull
                                                  @NonNull com.babylonhealth.lit.hl7.model.Observation.ReferenceRange... referenceRange)
        Parameters:
        referenceRange - - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.

      • withReferenceRange

        public ObservationBuilder.Impl withReferenceRange​(@NonNull
                                                  @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.Observation.ReferenceRange> referenceRange)
        Parameters:
        referenceRange - - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.

      • build

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