Package org.hl7.fhir.dstu2016may.model
Class GuidanceResponse
- 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 Description static classGuidanceResponse.GuidanceResponseActionBehaviorComponentstatic classGuidanceResponse.GuidanceResponseActionComponentstatic classGuidanceResponse.GuidanceResponseActionRelatedActionComponentstatic classGuidanceResponse.GuidanceResponseStatusstatic classGuidanceResponse.GuidanceResponseStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<GuidanceResponse.GuidanceResponseActionComponent>actionThe actions, if any, produced by the evaluation of the artifact.protected List<DataRequirement>dataRequirementIf 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>evaluationMessageMessages resulting from the evaluation of the artifact or artifacts.protected List<OperationOutcome>evaluationMessageTargetThe actual objects that are the target of the reference (Messages resulting from the evaluation of the artifact or artifacts.protected ReferencemoduleA reference to the knowledge module that was invoked.protected ResourcemoduleTargetThe actual object that is the target of the reference (A reference to the knowledge module that was invoked.)protected ReferenceoutputParametersThe output parameters of the evaluation, if any.protected ParametersoutputParametersTargetThe actual object that is the target of the reference (The output parameters of the evaluation, if any.protected StringTyperequestIdThe id of the request associated with this response.protected Enumeration<GuidanceResponse.GuidanceResponseStatus>statusThe 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
-
-
Constructor Summary
Constructors Constructor Description GuidanceResponse()ConstructorGuidanceResponse(Reference module, Enumeration<GuidanceResponse.GuidanceResponseStatus> status)Constructor
-
Method Summary
-
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
-
-
-
-
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.
-
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:
moduleThe 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-moduleThe 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:
outputParametersThe 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-outputParametersThe 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:
listChildrenin classDomainResource
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
Description copied from class:Basemake an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property- Overrides:
makePropertyin classDomainResource- Returns:
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public GuidanceResponse copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected GuidanceResponse typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-