Package org.hl7.fhir.r5.model

Class GuidanceResponse

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.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:

  • Field Details

    • requestIdentifier

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

    • identifier

      protected List<Identifier> identifier
      Allows a service to provide unique, business identifiers for the response.

    • module

      protected DataType module
      An identifier, CodeableConcept or canonical reference to the guidance that was requested.

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

    • encounter

      protected Reference encounter
      The encounter during which this response was created or to which the creation of this record is tightly associated.

    • occurrenceDateTime

      protected DateTimeType occurrenceDateTime
      Indicates when the guidance response was processed.

    • performer

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

    • reason

      protected List<CodeableReference> reason
      Describes the reason for the guidance response in coded or textual form, or 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.

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

    • result

      protected Reference result
      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_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

      See Also:

    • 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.where(resolve() is Patient)

      See Also:

    • 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.where(resolve() is Patient)

    • 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_REQUEST

      public static final String SP_REQUEST
      Search parameter: request

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

      See Also:

    • 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.requestIdentifier

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

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

      See Also:

    • STATUS

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

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

    • 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:

    • 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".

  • Constructor Details

  • Method Details