public class GuidanceResponse extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
GuidanceResponse.GuidanceResponseStatus |
static class |
GuidanceResponse.GuidanceResponseStatusEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
protected Reference |
context
Allows the context of the guidance response to be provided if available.
|
protected Resource |
contextTarget
The actual object that is the target of the reference (Allows the context of the guidance response to be provided if available.
|
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 Identifier |
identifier
Allows a service to provide a unique, business identifier for the response.
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
protected Reference |
module
A reference to the knowledge module that was invoked.
|
protected ServiceDefinition |
moduleTarget
The actual object that is the target of the reference (A reference to the knowledge module that was invoked.)
|
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 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 Type |
reason
Indicates the reason the request was initiated.
|
static TokenClientParam |
REQUEST
Fluent Client search parameter constant for request
|
protected IdType |
requestId
The id 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 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.)
|
contained, extension, modifierExtension, textid, implicitRules, language, metaRES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
GuidanceResponse()
Constructor
|
GuidanceResponse(Reference module,
Enumeration<GuidanceResponse.GuidanceResponseStatus> status)
Constructor
|
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextcopyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, isResource, setIdcastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDatagetMeta, getStructureFhirVersionEnum, setIdgetFormatCommentsPost, getFormatCommentsPre, hasFormatCommentprotected IdType requestId
protected Identifier identifier
protected ServiceDefinition moduleTarget
protected Enumeration<GuidanceResponse.GuidanceResponseStatus> status
protected Resource subjectTarget
protected Reference context
protected Resource contextTarget
protected DateTimeType occurrenceDateTime
protected Reference performer
protected Device performerTarget
protected Type reason
protected List<Annotation> note
protected List<Reference> evaluationMessage
protected List<OperationOutcome> evaluationMessageTarget
protected Reference outputParameters
protected Parameters outputParametersTarget
protected Resource resultTarget
protected List<DataRequirement> dataRequirement
public static final String SP_REQUEST
Description: The identifier of the request associated with the response
Type: token
Path: GuidanceResponse.requestId
public static final TokenClientParam REQUEST
Description: The identifier of the request associated with the response
Type: token
Path: GuidanceResponse.requestId
public static final String SP_IDENTIFIER
Description: The identifier of the guidance response
Type: token
Path: GuidanceResponse.identifier
public static final TokenClientParam IDENTIFIER
Description: The identifier of the guidance response
Type: token
Path: GuidanceResponse.identifier
public static final String SP_PATIENT
Description: The identity of a patient to search for guidance response results
Type: reference
Path: GuidanceResponse.subject
public static final ReferenceClientParam PATIENT
Description: The identity of a patient to search for guidance response results
Type: reference
Path: GuidanceResponse.subject
public static final Include INCLUDE_PATIENT
public static final String SP_SUBJECT
Description: The subject that the guidance response is about
Type: reference
Path: GuidanceResponse.subject
public static final ReferenceClientParam SUBJECT
Description: The subject that the guidance response is about
Type: reference
Path: GuidanceResponse.subject
public static final Include INCLUDE_SUBJECT
public GuidanceResponse()
public GuidanceResponse(Reference module, Enumeration<GuidanceResponse.GuidanceResponseStatus> status)
public IdType getRequestIdElement()
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 valuepublic boolean hasRequestIdElement()
public boolean hasRequestId()
public GuidanceResponse setRequestIdElement(IdType value)
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 valuepublic String getRequestId()
public GuidanceResponse setRequestId(String value)
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.public Identifier getIdentifier()
identifier (Allows a service to provide a unique, business identifier for the response.)public boolean hasIdentifier()
public GuidanceResponse setIdentifier(Identifier value)
value - identifier (Allows a service to provide a unique, business identifier for the response.)public Reference getModule()
module (A reference to the knowledge module that was invoked.)public boolean hasModule()
public GuidanceResponse setModule(Reference value)
value - module (A reference to the knowledge module that was invoked.)public ServiceDefinition getModuleTarget()
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.)public GuidanceResponse setModuleTarget(ServiceDefinition value)
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.)public Enumeration<GuidanceResponse.GuidanceResponseStatus> getStatusElement()
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 valuepublic boolean hasStatusElement()
public boolean hasStatus()
public GuidanceResponse setStatusElement(Enumeration<GuidanceResponse.GuidanceResponseStatus> value)
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 valuepublic GuidanceResponse.GuidanceResponseStatus getStatus()
public GuidanceResponse setStatus(GuidanceResponse.GuidanceResponseStatus value)
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.public Reference getSubject()
subject (The patient for which the request was processed.)public boolean hasSubject()
public GuidanceResponse setSubject(Reference value)
value - subject (The patient for which the request was processed.)public Resource getSubjectTarget()
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.)public GuidanceResponse setSubjectTarget(Resource value)
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.)public Reference getContext()
context (Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.)public boolean hasContext()
public GuidanceResponse setContext(Reference value)
value - context (Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.)public Resource getContextTarget()
context The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.)public GuidanceResponse setContextTarget(Resource value)
value - context The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.)public DateTimeType getOccurrenceDateTimeElement()
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 valuepublic boolean hasOccurrenceDateTimeElement()
public boolean hasOccurrenceDateTime()
public GuidanceResponse setOccurrenceDateTimeElement(DateTimeType value)
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 valuepublic Date getOccurrenceDateTime()
public GuidanceResponse setOccurrenceDateTime(Date value)
value - Indicates when the guidance response was processed.public Reference getPerformer()
performer (Provides a reference to the device that performed the guidance.)public boolean hasPerformer()
public GuidanceResponse setPerformer(Reference value)
value - performer (Provides a reference to the device that performed the guidance.)public Device getPerformerTarget()
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.)public GuidanceResponse setPerformerTarget(Device value)
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.)public Type getReason()
reason (Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.)public CodeableConcept getReasonCodeableConcept() throws FHIRException
reason (Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.)FHIRExceptionpublic boolean hasReasonCodeableConcept()
public Reference getReasonReference() throws FHIRException
reason (Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.)FHIRExceptionpublic boolean hasReasonReference()
public boolean hasReason()
public GuidanceResponse setReason(Type value)
value - reason (Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.)public List<Annotation> getNote()
note (Provides a mechanism to communicate additional information about the response.)public GuidanceResponse setNote(List<Annotation> theNote)
this for easy method chainingpublic boolean hasNote()
public Annotation addNote()
public GuidanceResponse addNote(Annotation t)
public Annotation getNoteFirstRep()
note, creating it if it does not already existpublic List<Reference> getEvaluationMessage()
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.)public GuidanceResponse setEvaluationMessage(List<Reference> theEvaluationMessage)
this for easy method chainingpublic boolean hasEvaluationMessage()
public Reference addEvaluationMessage()
public GuidanceResponse addEvaluationMessage(Reference t)
public Reference getEvaluationMessageFirstRep()
evaluationMessage, creating it if it does not already exist@Deprecated public List<OperationOutcome> getEvaluationMessageTarget()
@Deprecated public OperationOutcome addEvaluationMessageTarget()
public Reference getOutputParameters()
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.)public boolean hasOutputParameters()
public GuidanceResponse setOutputParameters(Reference value)
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.)public Parameters getOutputParametersTarget()
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.)public GuidanceResponse setOutputParametersTarget(Parameters value)
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.)public Reference getResult()
result (The actions, if any, produced by the evaluation of the artifact.)public boolean hasResult()
public GuidanceResponse setResult(Reference value)
value - result (The actions, if any, produced by the evaluation of the artifact.)public Resource getResultTarget()
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.)public GuidanceResponse setResultTarget(Resource value)
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.)public List<DataRequirement> getDataRequirement()
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.)public GuidanceResponse setDataRequirement(List<DataRequirement> theDataRequirement)
this for easy method chainingpublic boolean hasDataRequirement()
public DataRequirement addDataRequirement()
public GuidanceResponse addDataRequirement(DataRequirement t)
public DataRequirement getDataRequirementFirstRep()
dataRequirement, creating it if it does not already existprotected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic Base[] getProperty(int hash, String name, boolean checkValid) throws FHIRException
getProperty in class DomainResourceFHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws FHIRException
setProperty in class DomainResourceFHIRExceptionpublic Base setProperty(String name, Base value) throws FHIRException
setProperty in class DomainResourceFHIRExceptionpublic Base makeProperty(int hash, String name) throws FHIRException
makeProperty in class DomainResourceFHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws FHIRException
getTypesForProperty in class DomainResourceFHIRExceptionpublic Base addChild(String name) throws FHIRException
addChild in class DomainResourceFHIRExceptionpublic String fhirType()
fhirType in class DomainResourcepublic GuidanceResponse copy()
copy in class DomainResourceprotected GuidanceResponse typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2017 University Health Network. All rights reserved.