Package com.babylonhealth.lit.hl7_java.builders

Class GuidanceResponseBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.hl7.GUIDANCE_RESPONSE_STATUS status,
            @NonNull
            @NonNull Unions.ChoiceCanonicalOrCodeableConceptOrUri module)
        Required fields for GuidanceResponse
        Parameters:
        status - - The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.
        module - - An identifier, CodeableConcept or canonical reference to the guidance that was requested. Field is a 'choice' field. Type should be one of String, CodeableConcept. To pass the value in, wrap with one of the GuidanceResponseBuilder.module static methods

    • Method Detail

      • withId

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

      • withText

        public GuidanceResponseBuilder.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 GuidanceResponseBuilder.Impl withNote​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.Annotation... note)
        Parameters:
        note - - Provides a mechanism to communicate additional information about the response.

      • withNote

        public GuidanceResponseBuilder.Impl withNote​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Annotation> note)
        Parameters:
        note - - Provides a mechanism to communicate additional information about the response.

      • withNote

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

      • withResult

        public GuidanceResponseBuilder.Impl withResult​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.model.Reference result)
        Parameters:
        result - - The actions, if any, produced by the evaluation of the artifact.

      • withResult

        public GuidanceResponseBuilder.Impl withResult​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder result)

      • withSubject

        public GuidanceResponseBuilder.Impl withSubject​(@NonNull
                                                @NonNull com.babylonhealth.lit.core.model.Reference subject)
        Parameters:
        subject - - The patient for which the request was processed.

      • withSubject

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

      • withLanguage

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

      • withContained

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

      • withExtension

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

      • withEncounter

        public GuidanceResponseBuilder.Impl withEncounter​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core.model.Reference encounter)
        Parameters:
        encounter - - The encounter during which this response was created or to which the creation of this record is tightly associated.

      • withEncounter

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

      • withPerformer

        public GuidanceResponseBuilder.Impl withPerformer​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core.model.Reference performer)
        Parameters:
        performer - - Provides a reference to the device that performed the guidance.

      • withPerformer

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

      • withIdentifier

        public GuidanceResponseBuilder.Impl withIdentifier​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.Identifier... identifier)
        Parameters:
        identifier - - Allows a service to provide unique, business identifiers for the response.

      • withIdentifier

        public GuidanceResponseBuilder.Impl withIdentifier​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Identifier> identifier)
        Parameters:
        identifier - - Allows a service to provide unique, business identifiers for the response.

      • withIdentifier

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

      • withReasonCode

        public GuidanceResponseBuilder.Impl withReasonCode​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.CodeableConcept... reasonCode)
        Parameters:
        reasonCode - - Describes the reason for the guidance response in coded or textual form.

      • withReasonCode

        public GuidanceResponseBuilder.Impl withReasonCode​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> reasonCode)
        Parameters:
        reasonCode - - Describes the reason for the guidance response in coded or textual form.

      • withReasonCode

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

      • withImplicitRules

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

      • withReasonReference

        public GuidanceResponseBuilder.Impl withReasonReference​(@NonNull
                                                        @NonNull com.babylonhealth.lit.core.model.Reference... reasonReference)
        Parameters:
        reasonReference - - Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.

      • withReasonReference

        public GuidanceResponseBuilder.Impl withReasonReference​(@NonNull
                                                        @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> reasonReference)
        Parameters:
        reasonReference - - Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.

      • withReasonReference

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

      • withDataRequirement

        public GuidanceResponseBuilder.Impl withDataRequirement​(@NonNull
                                                        @NonNull com.babylonhealth.lit.core.model.DataRequirement... dataRequirement)
        Parameters:
        dataRequirement - - If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

      • withDataRequirement

        public GuidanceResponseBuilder.Impl withDataRequirement​(@NonNull
                                                        @NonNull java.util.Collection<com.babylonhealth.lit.core.model.DataRequirement> dataRequirement)
        Parameters:
        dataRequirement - - If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

      • withDataRequirement

        public GuidanceResponseBuilder.Impl withDataRequirement​(@NonNull
                                                        @NonNull com.babylonhealth.lit.core_java.builders.DataRequirementBuilder... dataRequirement)

      • withOutputParameters

        public GuidanceResponseBuilder.Impl withOutputParameters​(@NonNull
                                                         @NonNull com.babylonhealth.lit.core.model.Reference outputParameters)
        Parameters:
        outputParameters - - The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.

      • withOutputParameters

        public GuidanceResponseBuilder.Impl withOutputParameters​(@NonNull
                                                         @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder outputParameters)

      • withModifierExtension

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

      • withRequestIdentifier

        public GuidanceResponseBuilder.Impl withRequestIdentifier​(@NonNull
                                                          @NonNull com.babylonhealth.lit.core.model.Identifier requestIdentifier)
        Parameters:
        requestIdentifier - - The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.

      • withRequestIdentifier

        public GuidanceResponseBuilder.Impl withRequestIdentifier​(@NonNull
                                                          @NonNull com.babylonhealth.lit.core_java.builders.IdentifierBuilder requestIdentifier)

      • withEvaluationMessage

        public GuidanceResponseBuilder.Impl withEvaluationMessage​(@NonNull
                                                          @NonNull com.babylonhealth.lit.core.model.Reference... evaluationMessage)
        Parameters:
        evaluationMessage - - Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.

      • withEvaluationMessage

        public GuidanceResponseBuilder.Impl withEvaluationMessage​(@NonNull
                                                          @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> evaluationMessage)
        Parameters:
        evaluationMessage - - Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.

      • withEvaluationMessage

        public GuidanceResponseBuilder.Impl withEvaluationMessage​(@NonNull
                                                          @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... evaluationMessage)

      • withOccurrenceDateTime

        public GuidanceResponseBuilder.Impl withOccurrenceDateTime​(@NonNull
                                                           @NonNull com.babylonhealth.lit.core.FHIRDateTime occurrenceDateTime)
        Parameters:
        occurrenceDateTime - - Indicates when the guidance response was processed.

      • build

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