GuidanceResponse (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.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.GuidanceResponseActionBehaviorComponent`
`static class`	`GuidanceResponse.GuidanceResponseActionComponent`
`static class`	`GuidanceResponse.GuidanceResponseActionRelatedActionComponent`
`static class`	`GuidanceResponse.GuidanceResponseStatus`
`static class`	`GuidanceResponse.GuidanceResponseStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<GuidanceResponse.GuidanceResponseActionComponent>`	`action` The actions, if any, produced by the evaluation of the artifact.
`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 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 Reference`	`module` A reference to the knowledge module that was invoked.
`protected Resource`	`moduleTarget` The actual object that is the target of the reference (A reference to the knowledge module that was invoked.)
`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.
`protected StringType`	`requestId` The id of the request associated with this response.
`protected Enumeration<GuidanceResponse.GuidanceResponseStatus>`	`status` The status of the response.

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

Fields inherited from class org.hl7.fhir.dstu2016may.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(Reference module, Enumeration<GuidanceResponse.GuidanceResponseStatus> status)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GuidanceResponse.GuidanceResponseActionComponent`	`addAction()`
`GuidanceResponse`	`addAction(GuidanceResponse.GuidanceResponseActionComponent t)`
`Base`	`addChild(String name)`
`DataRequirement`	`addDataRequirement()`
`GuidanceResponse`	`addDataRequirement(DataRequirement t)`
`Reference`	`addEvaluationMessage()`
`GuidanceResponse`	`addEvaluationMessage(Reference t)`
`OperationOutcome`	`addEvaluationMessageTarget()`
`GuidanceResponse`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`List<GuidanceResponse.GuidanceResponseActionComponent>`	`getAction()`
`List<DataRequirement>`	`getDataRequirement()`
`List<Reference>`	`getEvaluationMessage()`
`List<OperationOutcome>`	`getEvaluationMessageTarget()`
`Reference`	`getModule()`
`Resource`	`getModuleTarget()`
`Reference`	`getOutputParameters()`
`Parameters`	`getOutputParametersTarget()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getRequestId()`
`StringType`	`getRequestIdElement()`
`ResourceType`	`getResourceType()`
`GuidanceResponse.GuidanceResponseStatus`	`getStatus()`
`Enumeration<GuidanceResponse.GuidanceResponseStatus>`	`getStatusElement()`
`boolean`	`hasAction()`
`boolean`	`hasDataRequirement()`
`boolean`	`hasEvaluationMessage()`
`boolean`	`hasModule()`
`boolean`	`hasOutputParameters()`
`boolean`	`hasRequestId()`
`boolean`	`hasRequestIdElement()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`GuidanceResponse`	`setModule(Reference value)`
`GuidanceResponse`	`setModuleTarget(Resource value)`
`GuidanceResponse`	`setOutputParameters(Reference value)`
`GuidanceResponse`	`setOutputParametersTarget(Parameters value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`GuidanceResponse`	`setRequestId(String value)`
`GuidanceResponse`	`setRequestIdElement(StringType value)`
`GuidanceResponse`	`setStatus(GuidanceResponse.GuidanceResponseStatus value)`
`GuidanceResponse`	`setStatusElement(Enumeration<GuidanceResponse.GuidanceResponseStatus> value)`
`protected GuidanceResponse`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

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

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

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, 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
  - requestId
```
protected StringType 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.
  - module
```
protected Reference module
```
    A reference to the knowledge module that was invoked.
  - moduleTarget
```
protected Resource 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.
  - 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.)
  - action
```
protected List<GuidanceResponse.GuidanceResponseActionComponent> action
```
    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.
- Constructor Detail
  - GuidanceResponse
```
public GuidanceResponse()
```
    Constructor
  - GuidanceResponse
```
public GuidanceResponse(Reference module,
                        Enumeration<GuidanceResponse.GuidanceResponseStatus> status)
```
    Constructor
- Method Detail
  - getRequestIdElement
```
public StringType 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
  - hasRequestIdElement
```
public boolean hasRequestIdElement()
```
  - hasRequestId
```
public boolean hasRequestId()
```
  - setRequestIdElement
```
public GuidanceResponse setRequestIdElement(StringType 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.
  - getModule
```
public Reference getModule()
```
    Returns:
    
    module (A reference to the knowledge module that was invoked.)
  - hasModule
```
public boolean hasModule()
```
  - setModule
```
public GuidanceResponse setModule(Reference value)
```
    Parameters:
    
    value - module (A reference to the knowledge module that was invoked.)
  - getModuleTarget
```
public Resource 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(Resource 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.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.
  - 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.)
  - hasEvaluationMessage
```
public boolean hasEvaluationMessage()
```
  - addEvaluationMessage
```
public Reference addEvaluationMessage()
```
    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.)
  - addEvaluationMessage
```
public GuidanceResponse addEvaluationMessage(Reference t)
```
  - getEvaluationMessageTarget
```
public List<OperationOutcome> getEvaluationMessageTarget()
```
    Returns:
    
    evaluationMessage (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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.)
  - addEvaluationMessageTarget
```
public OperationOutcome addEvaluationMessageTarget()
```
    Returns:
    
    evaluationMessage (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. 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.)
  - 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.)
  - getAction
```
public List<GuidanceResponse.GuidanceResponseActionComponent> getAction()
```
    Returns:
    
    action (The actions, if any, produced by the evaluation of the artifact.)
  - hasAction
```
public boolean hasAction()
```
  - addAction
```
public GuidanceResponse.GuidanceResponseActionComponent addAction()
```
    Returns:
    
    action (The actions, if any, produced by the evaluation of the artifact.)
  - addAction
```
public GuidanceResponse addAction(GuidanceResponse.GuidanceResponseActionComponent t)
```
  - 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.)
  - hasDataRequirement
```
public boolean hasDataRequirement()
```
  - addDataRequirement
```
public DataRequirement addDataRequirement()
```
    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.)
  - addDataRequirement
```
public GuidanceResponse addDataRequirement(DataRequirement t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - 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 void 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 void 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
  - 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()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public GuidanceResponse copy()
```
    Specified by:
    
    copy in class DomainResource
  - 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.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.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.dstu2016may.model.DomainResource

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

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

Methods inherited from class org.hl7.fhir.dstu2016may.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

requestId

module

moduleTarget

status

evaluationMessage

evaluationMessageTarget

outputParameters

outputParametersTarget

action

dataRequirement

Constructor Detail

GuidanceResponse

GuidanceResponse

Method Detail

getRequestIdElement

hasRequestIdElement

hasRequestId

setRequestIdElement

getRequestId

setRequestId

getModule

hasModule

setModule

getModuleTarget

setModuleTarget

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getEvaluationMessage

hasEvaluationMessage

addEvaluationMessage

addEvaluationMessage

getEvaluationMessageTarget

addEvaluationMessageTarget

getOutputParameters

hasOutputParameters

setOutputParameters

getOutputParametersTarget

setOutputParametersTarget

getAction

hasAction

addAction

addAction

getDataRequirement

hasDataRequirement

addDataRequirement

addDataRequirement

listChildren

getProperty

setProperty

setProperty

makeProperty

addChild

fhirType

copy

typedCopy

equalsDeep

equalsShallow

isEmpty