Class GuidanceResponse

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    public class GuidanceResponse
    extends DomainResource
    A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.
    See Also:
    Serialized Form
    • Field Detail

      • requestId

        protected IdType requestId
        The id of the request associated with this response. If an id 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.
      • identifier

        protected Identifier identifier
        Allows a service to provide a unique, business identifier for the response.
      • module

        protected Reference module
        A reference to the knowledge module that was invoked.
      • moduleTarget

        protected ServiceDefinition moduleTarget
        The actual object that is the target of the reference (A reference to the knowledge module that was invoked.)
      • status

        protected Enumeration<GuidanceResponse.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.
      • subject

        protected Reference subject
        The patient for which the request was processed.
      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (The patient for which the request was processed.)
      • context

        protected Reference context
        Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.
      • contextTarget

        protected Resource contextTarget
        The actual object that is the target of the reference (Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.)
      • performer

        protected Reference performer
        Provides a reference to the device that performed the guidance.
      • performerTarget

        protected Device performerTarget
        The actual object that is the target of the reference (Provides a reference to the device that performed the guidance.)
      • reason

        protected Type reason
        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.
      • note

        protected List<Annotation> note
        Provides a mechanism to communicate additional information about the response.
      • evaluationMessage

        protected List<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.
      • evaluationMessageTarget

        protected List<OperationOutcome> evaluationMessageTarget
        The actual objects that are the target of the reference (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.)
      • outputParameters

        protected 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.
      • outputParametersTarget

        protected Parameters outputParametersTarget
        The actual object that is the target of the reference (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.)
      • result

        protected Reference result
        The actions, if any, produced by the evaluation of the artifact.
      • resultTarget

        protected Resource resultTarget
        The actual object that is the target of the reference (The actions, if any, produced by the evaluation of the artifact.)
      • dataRequirement

        protected List<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.
      • SP_REQUEST

        public static final String SP_REQUEST
        Search parameter: request

        Description: The identifier of the request associated with the response
        Type: token
        Path: GuidanceResponse.requestId

        See Also:
        Constant Field Values
      • REQUEST

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam REQUEST
        Fluent Client search parameter constant for request

        Description: The identifier of the request associated with the response
        Type: token
        Path: GuidanceResponse.requestId

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: The identifier of the guidance response
        Type: token
        Path: GuidanceResponse.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: The identifier of the guidance response
        Type: token
        Path: GuidanceResponse.identifier

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: The identity of a patient to search for guidance response results
        Type: reference
        Path: GuidanceResponse.subject

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: The identity of a patient to search for guidance response results
        Type: reference
        Path: GuidanceResponse.subject

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "GuidanceResponse:patient".
      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: The subject that the guidance response is about
        Type: reference
        Path: GuidanceResponse.subject

        See Also:
        Constant Field Values
      • SUBJECT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
        Fluent Client search parameter constant for subject

        Description: The subject that the guidance response is about
        Type: reference
        Path: GuidanceResponse.subject

      • INCLUDE_SUBJECT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "GuidanceResponse:subject".
    • Method Detail

      • getRequestIdElement

        public IdType getRequestIdElement()
        Returns:
        requestId (The id of the request associated with this response. If an id 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.). This is the underlying object with id, value and extensions. The accessor "getRequestId" gives direct access to the value
      • setRequestIdElement

        public GuidanceResponse setRequestIdElement​(IdType value)
        Parameters:
        value - requestId (The id of the request associated with this response. If an id 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.). This is the underlying object with id, value and extensions. The accessor "getRequestId" gives direct access to the value
      • getRequestId

        public String getRequestId()
        Returns:
        The id of the request associated with this response. If an id 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.
      • setRequestId

        public GuidanceResponse setRequestId​(String value)
        Parameters:
        value - The id of the request associated with this response. If an id 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.
      • getModuleTarget

        public ServiceDefinition getModuleTarget()
        Returns:
        module The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A reference to the knowledge module that was invoked.)
      • setModuleTarget

        public GuidanceResponse setModuleTarget​(ServiceDefinition value)
        Parameters:
        value - module The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A reference to the knowledge module that was invoked.)
      • getStatusElement

        public Enumeration<GuidanceResponse.GuidanceResponseStatusgetStatusElement()
        Returns:
        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 is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
      • setStatusElement

        public GuidanceResponse setStatusElement​(Enumeration<GuidanceResponse.GuidanceResponseStatus> value)
        Parameters:
        value - 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 is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
      • getStatus

        public GuidanceResponse.GuidanceResponseStatus getStatus()
        Returns:
        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.
      • setStatus

        public GuidanceResponse setStatus​(GuidanceResponse.GuidanceResponseStatus value)
        Parameters:
        value - 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.
      • getSubjectTarget

        public Resource getSubjectTarget()
        Returns:
        subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient for which the request was processed.)
      • setSubjectTarget

        public GuidanceResponse setSubjectTarget​(Resource value)
        Parameters:
        value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient for which the request was processed.)
      • getContext

        public Reference getContext()
        Returns:
        context (Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.)
      • setContext

        public GuidanceResponse setContext​(Reference value)
        Parameters:
        value - context (Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.)
      • getContextTarget

        public Resource getContextTarget()
        Returns:
        context The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.)
      • setContextTarget

        public GuidanceResponse setContextTarget​(Resource value)
        Parameters:
        value - context The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.)
      • getOccurrenceDateTimeElement

        public DateTimeType getOccurrenceDateTimeElement()
        Returns:
        occurrenceDateTime (Indicates when the guidance response was processed.). This is the underlying object with id, value and extensions. The accessor "getOccurrenceDateTime" gives direct access to the value
      • getPerformerTarget

        public Device getPerformerTarget()
        Returns:
        performer The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Provides a reference to the device that performed the guidance.)
      • setPerformerTarget

        public GuidanceResponse setPerformerTarget​(Device value)
        Parameters:
        value - performer The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Provides a reference to the device that performed the guidance.)
      • getReason

        public Type getReason()
        Returns:
        reason (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.)
      • getReasonCodeableConcept

        public CodeableConcept getReasonCodeableConcept()
                                                 throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        reason (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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getReasonReference

        public Reference getReasonReference()
                                     throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        reason (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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • setReason

        public GuidanceResponse setReason​(Type value)
                                   throws org.hl7.fhir.exceptions.FHIRFormatError
        Parameters:
        value - reason (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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRFormatError
      • getNote

        public List<AnnotationgetNote()
        Returns:
        note (Provides a mechanism to communicate additional information about the response.)
      • hasNote

        public boolean hasNote()
      • getNoteFirstRep

        public Annotation getNoteFirstRep()
        Returns:
        The first repetition of repeating field note, creating it if it does not already exist
      • getEvaluationMessage

        public List<ReferencegetEvaluationMessage()
        Returns:
        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.)
      • getOutputParameters

        public Reference getOutputParameters()
        Returns:
        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.)
      • setOutputParameters

        public GuidanceResponse setOutputParameters​(Reference value)
        Parameters:
        value - 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.)
      • getOutputParametersTarget

        public Parameters getOutputParametersTarget()
        Returns:
        outputParameters The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)
      • setOutputParametersTarget

        public GuidanceResponse setOutputParametersTarget​(Parameters value)
        Parameters:
        value - outputParameters The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
      • getResult

        public Reference getResult()
        Returns:
        result (The actions, if any, produced by the evaluation of the artifact.)
      • getResultTarget

        public Resource getResultTarget()
        Returns:
        result The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The actions, if any, produced by the evaluation of the artifact.)
      • setResultTarget

        public GuidanceResponse setResultTarget​(Resource value)
        Parameters:
        value - result The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The actions, if any, produced by the evaluation of the artifact.)
      • getDataRequirement

        public List<DataRequirementgetDataRequirement()
        Returns:
        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.)
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource