GuidanceResponse (org.hl7.fhir.r4 5.4.0 API)

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

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GuidanceResponse.GuidanceResponseStatus

static class GuidanceResponse.GuidanceResponseStatusEnumFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`GuidanceResponse.GuidanceResponseStatus`
`static class`	`GuidanceResponse.GuidanceResponseStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`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.
`protected Reference`	`encounter` The encounter during which this response was created or to which the creation of this record is tightly associated.
`protected Encounter`	`encounterTarget` The actual object that is the target of the reference (The encounter during which this response was created or to which the creation of this record is tightly associated.)
`protected List<Reference>`	`evaluationMessage` Messages resulting from the evaluation of the artifact or artifacts.
`protected List<OperationOutcome>`	`evaluationMessageTarget` The actual objects that are the target of the reference (Messages resulting from the evaluation of the artifact or artifacts.
`protected List<Identifier>`	`identifier` Allows a service to provide unique, business identifiers for the response.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`protected Type`	`module` An identifier, CodeableConcept or canonical reference to the guidance that was requested.
`protected List<Annotation>`	`note` Provides a mechanism to communicate additional information about the response.
`protected DateTimeType`	`occurrenceDateTime` Indicates when the guidance response was processed.
`protected Reference`	`outputParameters` The output parameters of the evaluation, if any.
`protected Parameters`	`outputParametersTarget` The actual object that is the target of the reference (The output parameters of the evaluation, if any.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected Reference`	`performer` Provides a reference to the device that performed the guidance.
`protected Device`	`performerTarget` The actual object that is the target of the reference (Provides a reference to the device that performed the guidance.)
`protected List<CodeableConcept>`	`reasonCode` Describes the reason for the guidance response in coded or textual form.
`protected List<Reference>`	`reasonReference` Indicates the reason the request was initiated.
`protected List<Resource>`	`reasonReferenceTarget` The actual objects that are the target of the reference (Indicates the reason the request was initiated.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`REQUEST` Fluent Client search parameter constant for request
`protected Identifier`	`requestIdentifier` The identifier of the request associated with this response.
`protected Reference`	`result` The actions, if any, produced by the evaluation of the artifact.
`protected Resource`	`resultTarget` The actual object that is the target of the reference (The actions, if any, produced by the evaluation of the artifact.)
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_REQUEST` Search parameter: request
`static String`	`SP_SUBJECT` Search parameter: subject
`protected Enumeration<GuidanceResponse.GuidanceResponseStatus>`	`status` The status of the response.
`protected Reference`	`subject` The patient for which the request was processed.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (The patient for which the request was processed.)

Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description
`GuidanceResponse()` Constructor
`GuidanceResponse(Type module, Enumeration<GuidanceResponse.GuidanceResponseStatus> status)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`DataRequirement`	`addDataRequirement()`
`GuidanceResponse`	`addDataRequirement(DataRequirement t)`
`Reference`	`addEvaluationMessage()`
`GuidanceResponse`	`addEvaluationMessage(Reference t)`
`OperationOutcome`	`addEvaluationMessageTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Identifier`	`addIdentifier()`
`GuidanceResponse`	`addIdentifier(Identifier t)`
`Annotation`	`addNote()`
`GuidanceResponse`	`addNote(Annotation t)`
`CodeableConcept`	`addReasonCode()`
`GuidanceResponse`	`addReasonCode(CodeableConcept t)`
`Reference`	`addReasonReference()`
`GuidanceResponse`	`addReasonReference(Reference t)`
`GuidanceResponse`	`copy()`
`void`	`copyValues(GuidanceResponse dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`List<DataRequirement>`	`getDataRequirement()`
`DataRequirement`	`getDataRequirementFirstRep()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`List<Reference>`	`getEvaluationMessage()`
`Reference`	`getEvaluationMessageFirstRep()`
`List<OperationOutcome>`	`getEvaluationMessageTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`Type`	`getModule()`
`CanonicalType`	`getModuleCanonicalType()`
`CodeableConcept`	`getModuleCodeableConcept()`
`UriType`	`getModuleUriType()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<Annotation>`	`getNote()`
`Annotation`	`getNoteFirstRep()`
`Date`	`getOccurrenceDateTime()`
`DateTimeType`	`getOccurrenceDateTimeElement()`
`Reference`	`getOutputParameters()`
`Parameters`	`getOutputParametersTarget()`
`Reference`	`getPerformer()`
`Device`	`getPerformerTarget()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<CodeableConcept>`	`getReasonCode()`
`CodeableConcept`	`getReasonCodeFirstRep()`
`List<Reference>`	`getReasonReference()`
`Reference`	`getReasonReferenceFirstRep()`
`List<Resource>`	`getReasonReferenceTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Identifier`	`getRequestIdentifier()`
`ResourceType`	`getResourceType()`
`Reference`	`getResult()`
`Resource`	`getResultTarget()`
`GuidanceResponse.GuidanceResponseStatus`	`getStatus()`
`Enumeration<GuidanceResponse.GuidanceResponseStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasDataRequirement()`
`boolean`	`hasEncounter()`
`boolean`	`hasEvaluationMessage()`
`boolean`	`hasIdentifier()`
`boolean`	`hasModule()`
`boolean`	`hasModuleCanonicalType()`
`boolean`	`hasModuleCodeableConcept()`
`boolean`	`hasModuleUriType()`
`boolean`	`hasNote()`
`boolean`	`hasOccurrenceDateTime()`
`boolean`	`hasOccurrenceDateTimeElement()`
`boolean`	`hasOutputParameters()`
`boolean`	`hasPerformer()`
`boolean`	`hasReasonCode()`
`boolean`	`hasReasonReference()`
`boolean`	`hasRequestIdentifier()`
`boolean`	`hasResult()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`GuidanceResponse`	`setDataRequirement(List<DataRequirement> theDataRequirement)`
`GuidanceResponse`	`setEncounter(Reference value)`
`GuidanceResponse`	`setEncounterTarget(Encounter value)`
`GuidanceResponse`	`setEvaluationMessage(List<Reference> theEvaluationMessage)`
`GuidanceResponse`	`setIdentifier(List<Identifier> theIdentifier)`
`GuidanceResponse`	`setModule(Type value)`
`GuidanceResponse`	`setNote(List<Annotation> theNote)`
`GuidanceResponse`	`setOccurrenceDateTime(Date value)`
`GuidanceResponse`	`setOccurrenceDateTimeElement(DateTimeType value)`
`GuidanceResponse`	`setOutputParameters(Reference value)`
`GuidanceResponse`	`setOutputParametersTarget(Parameters value)`
`GuidanceResponse`	`setPerformer(Reference value)`
`GuidanceResponse`	`setPerformerTarget(Device value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`GuidanceResponse`	`setReasonCode(List<CodeableConcept> theReasonCode)`
`GuidanceResponse`	`setReasonReference(List<Reference> theReasonReference)`
`GuidanceResponse`	`setRequestIdentifier(Identifier value)`
`GuidanceResponse`	`setResult(Reference value)`
`GuidanceResponse`	`setResultTarget(Resource value)`
`GuidanceResponse`	`setStatus(GuidanceResponse.GuidanceResponseStatus value)`
`GuidanceResponse`	`setStatusElement(Enumeration<GuidanceResponse.GuidanceResponseStatus> value)`
`GuidanceResponse`	`setSubject(Reference value)`
`GuidanceResponse`	`setSubjectTarget(Resource value)`
`protected GuidanceResponse`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - 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 Type 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.
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (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.
  - encounterTarget
```
protected Encounter encounterTarget
```
    The actual object that is the target of the reference (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.
  - performerTarget
```
protected Device performerTarget
```
    The actual object that is the target of the reference (Provides a reference to the device that performed the guidance.)
  - reasonCode
```
protected List<CodeableConcept> reasonCode
```
    Describes the reason for the guidance response in coded or textual form.
  - reasonReference
```
protected List<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.
  - reasonReferenceTarget
```
protected List<Resource> reasonReferenceTarget
```
    The actual objects that are the target of the reference (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.requestIdentifier
    
    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.requestIdentifier
  - 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".
- Constructor Detail
  - GuidanceResponse
```
public GuidanceResponse()
```
    Constructor
  - GuidanceResponse
```
public GuidanceResponse(Type module,
                        Enumeration<GuidanceResponse.GuidanceResponseStatus> status)
```
    Constructor
- Method Detail
  - getRequestIdentifier
```
public Identifier getRequestIdentifier()
```
    Returns:
    
    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.)
  - hasRequestIdentifier
```
public boolean hasRequestIdentifier()
```
  - setRequestIdentifier
```
public GuidanceResponse setRequestIdentifier(Identifier value)
```
    Parameters:
    
    value - 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.)
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Allows a service to provide unique, business identifiers for the response.)
  - setIdentifier
```
public GuidanceResponse setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public GuidanceResponse addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getModule
```
public Type getModule()
```
    Returns:
    
    module (An identifier, CodeableConcept or canonical reference to the guidance that was requested.)
  - getModuleUriType
```
public UriType getModuleUriType()
                         throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    module (An identifier, CodeableConcept or canonical reference to the guidance that was requested.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasModuleUriType
```
public boolean hasModuleUriType()
```
  - getModuleCanonicalType
```
public CanonicalType getModuleCanonicalType()
                                     throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    module (An identifier, CodeableConcept or canonical reference to the guidance that was requested.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasModuleCanonicalType
```
public boolean hasModuleCanonicalType()
```
  - getModuleCodeableConcept
```
public CodeableConcept getModuleCodeableConcept()
                                         throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    module (An identifier, CodeableConcept or canonical reference to the guidance that was requested.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasModuleCodeableConcept
```
public boolean hasModuleCodeableConcept()
```
  - hasModule
```
public boolean hasModule()
```
  - setModule
```
public GuidanceResponse setModule(Type value)
```
    Parameters:
    
    value - module (An identifier, CodeableConcept or canonical reference to the guidance that was requested.)
  - getStatusElement
```
public Enumeration<GuidanceResponse.GuidanceResponseStatus> getStatusElement()
```
    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
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - 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.
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (The patient for which the request was processed.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public GuidanceResponse setSubject(Reference value)
```
    Parameters:
    
    value - subject (The patient for which the request was processed.)
  - 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.)
  - getEncounter
```
public Reference getEncounter()
```
    Returns:
    
    encounter (The encounter during which this response was created or to which the creation of this record is tightly associated.)
  - hasEncounter
```
public boolean hasEncounter()
```
  - setEncounter
```
public GuidanceResponse setEncounter(Reference value)
```
    Parameters:
    
    value - encounter (The encounter during which this response was created or to which the creation of this record is tightly associated.)
  - getEncounterTarget
```
public Encounter getEncounterTarget()
```
    Returns:
    
    encounter 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 encounter during which this response was created or to which the creation of this record is tightly associated.)
  - setEncounterTarget
```
public GuidanceResponse setEncounterTarget(Encounter value)
```
    Parameters:
    
    value - encounter 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 encounter during which this response was created or to which the creation of this record is tightly associated.)
  - 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
  - hasOccurrenceDateTimeElement
```
public boolean hasOccurrenceDateTimeElement()
```
  - hasOccurrenceDateTime
```
public boolean hasOccurrenceDateTime()
```
  - setOccurrenceDateTimeElement
```
public GuidanceResponse setOccurrenceDateTimeElement(DateTimeType value)
```
    Parameters:
    
    value - 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
  - getOccurrenceDateTime
```
public Date getOccurrenceDateTime()
```
    Returns:
    
    Indicates when the guidance response was processed.
  - setOccurrenceDateTime
```
public GuidanceResponse setOccurrenceDateTime(Date value)
```
    Parameters:
    
    value - Indicates when the guidance response was processed.
  - getPerformer
```
public Reference getPerformer()
```
    Returns:
    
    performer (Provides a reference to the device that performed the guidance.)
  - hasPerformer
```
public boolean hasPerformer()
```
  - setPerformer
```
public GuidanceResponse setPerformer(Reference value)
```
    Parameters:
    
    value - performer (Provides a reference to the device that performed the guidance.)
  - 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.)
  - getReasonCode
```
public List<CodeableConcept> getReasonCode()
```
    Returns:
    
    reasonCode (Describes the reason for the guidance response in coded or textual form.)
  - setReasonCode
```
public GuidanceResponse setReasonCode(List<CodeableConcept> theReasonCode)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasReasonCode
```
public boolean hasReasonCode()
```
  - addReasonCode
```
public CodeableConcept addReasonCode()
```
  - addReasonCode
```
public GuidanceResponse addReasonCode(CodeableConcept t)
```
  - getReasonCodeFirstRep
```
public CodeableConcept getReasonCodeFirstRep()
```
    Returns:
    
    The first repetition of repeating field reasonCode, creating it if it does not already exist
  - getReasonReference
```
public List<Reference> getReasonReference()
```
    Returns:
    
    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.)
  - setReasonReference
```
public GuidanceResponse setReasonReference(List<Reference> theReasonReference)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasReasonReference
```
public boolean hasReasonReference()
```
  - addReasonReference
```
public Reference addReasonReference()
```
  - addReasonReference
```
public GuidanceResponse addReasonReference(Reference t)
```
  - getReasonReferenceFirstRep
```
public Reference getReasonReferenceFirstRep()
```
    Returns:
    
    The first repetition of repeating field reasonReference, creating it if it does not already exist
  - getReasonReferenceTarget
```
@Deprecated
public List<Resource> getReasonReferenceTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getNote
```
public List<Annotation> getNote()
```
    Returns:
    
    note (Provides a mechanism to communicate additional information about the response.)
  - setNote
```
public GuidanceResponse setNote(List<Annotation> theNote)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
  - addNote
```
public GuidanceResponse addNote(Annotation t)
```
  - getNoteFirstRep
```
public Annotation getNoteFirstRep()
```
    Returns:
    
    The first repetition of repeating field note, creating it if it does not already exist
  - getEvaluationMessage
```
public List<Reference> getEvaluationMessage()
```
    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.)
  - setEvaluationMessage
```
public GuidanceResponse setEvaluationMessage(List<Reference> theEvaluationMessage)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasEvaluationMessage
```
public boolean hasEvaluationMessage()
```
  - addEvaluationMessage
```
public Reference addEvaluationMessage()
```
  - addEvaluationMessage
```
public GuidanceResponse addEvaluationMessage(Reference t)
```
  - getEvaluationMessageFirstRep
```
public Reference getEvaluationMessageFirstRep()
```
    Returns:
    
    The first repetition of repeating field evaluationMessage, creating it if it does not already exist
  - getEvaluationMessageTarget
```
@Deprecated
public List<OperationOutcome> getEvaluationMessageTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addEvaluationMessageTarget
```
@Deprecated
public OperationOutcome addEvaluationMessageTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - 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.)
  - hasOutputParameters
```
public boolean hasOutputParameters()
```
  - 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.)
  - hasResult
```
public boolean hasResult()
```
  - setResult
```
public GuidanceResponse setResult(Reference value)
```
    Parameters:
    
    value - 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<DataRequirement> getDataRequirement()
```
    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.)
  - setDataRequirement
```
public GuidanceResponse setDataRequirement(List<DataRequirement> theDataRequirement)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasDataRequirement
```
public boolean hasDataRequirement()
```
  - addDataRequirement
```
public DataRequirement addDataRequirement()
```
  - addDataRequirement
```
public GuidanceResponse addDataRequirement(DataRequirement t)
```
  - getDataRequirementFirstRep
```
public DataRequirement getDataRequirementFirstRep()
```
    Returns:
    
    The first repetition of repeating field dataRequirement, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - 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
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public GuidanceResponse copy()
```
    Specified by:
    
    copy in class DomainResource
  - copyValues
```
public void copyValues(GuidanceResponse dst)
```
  - typedCopy
```
protected GuidanceResponse typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class GuidanceResponse

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

Fields inherited from class org.hl7.fhir.r4.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

Methods inherited from class org.hl7.fhir.r4.model.Resource

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

Methods inherited from class org.hl7.fhir.r4.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

requestIdentifier

identifier

module

status

subject

subjectTarget

encounter

encounterTarget

occurrenceDateTime

performer

performerTarget

reasonCode

reasonReference

reasonReferenceTarget

note

evaluationMessage

evaluationMessageTarget

outputParameters

outputParametersTarget

result

resultTarget

dataRequirement

SP_REQUEST

REQUEST

SP_IDENTIFIER

IDENTIFIER

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

Constructor Detail

GuidanceResponse

GuidanceResponse

Method Detail

getRequestIdentifier

hasRequestIdentifier

setRequestIdentifier

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getModule

getModuleUriType

hasModuleUriType

getModuleCanonicalType

hasModuleCanonicalType

getModuleCodeableConcept

hasModuleCodeableConcept

hasModule

setModule

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getSubject

hasSubject