Package org.linuxforhealth.fhir.model.resource

Class GuidanceResponse.Builder

    • Method Detail

      • id

        public GuidanceResponse.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public GuidanceResponse.Builder meta​(Meta 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.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public GuidanceResponse.Builder implicitRules​(Uri 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.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • text

        public GuidanceResponse.Builder text​(Narrative 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.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public GuidanceResponse.Builder contained​(Resource... 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.

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

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public GuidanceResponse.Builder contained​(java.util.Collection<Resource> 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.

        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:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public GuidanceResponse.Builder extension​(Extension... 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.

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

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public GuidanceResponse.Builder extension​(java.util.Collection<Extension> 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.

        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 DomainResource.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 GuidanceResponse.Builder modifierExtension​(Extension... 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).

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

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public GuidanceResponse.Builder modifierExtension​(java.util.Collection<Extension> 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).

        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 DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • requestIdentifier

        public GuidanceResponse.Builder requestIdentifier​(Identifier 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.
        Parameters:
        requestIdentifier - The identifier of the request associated with this response, if any
        Returns:
        A reference to this Builder instance

      • identifier

        public GuidanceResponse.Builder identifier​(Identifier... identifier)
        Allows a service to provide unique, business identifiers for the response.

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

        Parameters:
        identifier - Business identifier
        Returns:
        A reference to this Builder instance

      • identifier

        public GuidanceResponse.Builder identifier​(java.util.Collection<Identifier> identifier)
        Allows a service to provide unique, business identifiers for the response.

        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:
        identifier - Business identifier
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • module

        public GuidanceResponse.Builder module​(Element module)
        An identifier, CodeableConcept or canonical reference to the guidance that was requested.

        This element is required.

        This is a choice element with the following allowed types:

        Parameters:
        module - What guidance was requested
        Returns:
        A reference to this Builder instance

      • status

        public GuidanceResponse.Builder status​(GuidanceResponseStatus 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.

        This element is required.

        Parameters:
        status - success | data-requested | data-required | in-progress | failure | entered-in-error
        Returns:
        A reference to this Builder instance

      • subject

        public GuidanceResponse.Builder subject​(Reference subject)
        The patient for which the request was processed.

        Allowed resource types for this reference:

        Parameters:
        subject - Patient the request was performed for
        Returns:
        A reference to this Builder instance

      • encounter

        public GuidanceResponse.Builder encounter​(Reference encounter)
        The encounter during which this response was created or to which the creation of this record is tightly associated.

        Allowed resource types for this reference:

        Parameters:
        encounter - Encounter during which the response was returned
        Returns:
        A reference to this Builder instance

      • occurrenceDateTime

        public GuidanceResponse.Builder occurrenceDateTime​(DateTime occurrenceDateTime)
        Indicates when the guidance response was processed.
        Parameters:
        occurrenceDateTime - When the guidance response was processed
        Returns:
        A reference to this Builder instance

      • performer

        public GuidanceResponse.Builder performer​(Reference performer)
        Provides a reference to the device that performed the guidance.

        Allowed resource types for this reference:

        Parameters:
        performer - Device returning the guidance
        Returns:
        A reference to this Builder instance

      • reasonCode

        public GuidanceResponse.Builder reasonCode​(CodeableConcept... reasonCode)
        Describes the reason for the guidance response in coded or textual form.

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

        Parameters:
        reasonCode - Why guidance is needed
        Returns:
        A reference to this Builder instance

      • reasonCode

        public GuidanceResponse.Builder reasonCode​(java.util.Collection<CodeableConcept> reasonCode)
        Describes the reason for the guidance response in coded or textual form.

        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:
        reasonCode - Why guidance is needed
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • reasonReference

        public GuidanceResponse.Builder reasonReference​(Reference... 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.

        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:
        reasonReference - Why guidance is needed
        Returns:
        A reference to this Builder instance

      • reasonReference

        public GuidanceResponse.Builder reasonReference​(java.util.Collection<Reference> 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.

        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:
        reasonReference - Why guidance is needed
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • note

        public GuidanceResponse.Builder note​(Annotation... note)
        Provides a mechanism to communicate additional information about the response.

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

        Parameters:
        note - Additional notes about the response
        Returns:
        A reference to this Builder instance

      • note

        public GuidanceResponse.Builder note​(java.util.Collection<Annotation> note)
        Provides a mechanism to communicate additional information about the response.

        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:
        note - Additional notes about the response
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • evaluationMessage

        public GuidanceResponse.Builder evaluationMessage​(Reference... 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.

        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:
        evaluationMessage - Messages resulting from the evaluation of the artifact or artifacts
        Returns:
        A reference to this Builder instance

      • evaluationMessage

        public GuidanceResponse.Builder evaluationMessage​(java.util.Collection<Reference> 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.

        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:
        evaluationMessage - Messages resulting from the evaluation of the artifact or artifacts
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • outputParameters

        public GuidanceResponse.Builder outputParameters​(Reference 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.

        Allowed resource types for this reference:

        Parameters:
        outputParameters - The output parameters of the evaluation, if any
        Returns:
        A reference to this Builder instance

      • result

        public GuidanceResponse.Builder result​(Reference result)
        The actions, if any, produced by the evaluation of the artifact.

        Allowed resource types for this reference:

        Parameters:
        result - Proposed actions, if any
        Returns:
        A reference to this Builder instance

      • dataRequirement

        public GuidanceResponse.Builder dataRequirement​(DataRequirement... 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.

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

        Parameters:
        dataRequirement - Additional required data
        Returns:
        A reference to this Builder instance

      • dataRequirement

        public GuidanceResponse.Builder dataRequirement​(java.util.Collection<DataRequirement> 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.

        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:
        dataRequirement - Additional required data
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null