Class GuidanceResponse
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.GuidanceResponse
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") 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.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GuidanceResponse.Builder
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static GuidanceResponse.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<DataRequirement>
getDataRequirement()
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.Reference
getEncounter()
The encounter during which this response was created or to which the creation of this record is tightly associated.java.util.List<Reference>
getEvaluationMessage()
Messages resulting from the evaluation of the artifact or artifacts.java.util.List<Identifier>
getIdentifier()
Allows a service to provide unique, business identifiers for the response.Element
getModule()
An identifier, CodeableConcept or canonical reference to the guidance that was requested.java.util.List<Annotation>
getNote()
Provides a mechanism to communicate additional information about the response.DateTime
getOccurrenceDateTime()
Indicates when the guidance response was processed.Reference
getOutputParameters()
The output parameters of the evaluation, if any.Reference
getPerformer()
Provides a reference to the device that performed the guidance.java.util.List<CodeableConcept>
getReasonCode()
Describes the reason for the guidance response in coded or textual form.java.util.List<Reference>
getReasonReference()
Indicates the reason the request was initiated.Identifier
getRequestIdentifier()
The identifier of the request associated with this response.Reference
getResult()
The actions, if any, produced by the evaluation of the artifact.GuidanceResponseStatus
getStatus()
The status of the response.Reference
getSubject()
The patient for which the request was processed.boolean
hasChildren()
int
hashCode()
GuidanceResponse.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getRequestIdentifier
public Identifier getRequestIdentifier()
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.- Returns:
- An immutable object of type
Identifier
that may be null.
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Allows a service to provide unique, business identifiers for the response.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getModule
public Element getModule()
An identifier, CodeableConcept or canonical reference to the guidance that was requested.- Returns:
- An immutable object of type
Uri
,Canonical
orCodeableConcept
that is non-null.
-
getStatus
public GuidanceResponseStatus getStatus()
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.- Returns:
- An immutable object of type
GuidanceResponseStatus
that is non-null.
-
getSubject
public Reference getSubject()
The patient for which the request was processed.- Returns:
- An immutable object of type
Reference
that may be null.
-
getEncounter
public Reference getEncounter()
The encounter during which this response was created or to which the creation of this record is tightly associated.- Returns:
- An immutable object of type
Reference
that may be null.
-
getOccurrenceDateTime
public DateTime getOccurrenceDateTime()
Indicates when the guidance response was processed.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getPerformer
public Reference getPerformer()
Provides a reference to the device that performed the guidance.- Returns:
- An immutable object of type
Reference
that may be null.
-
getReasonCode
public java.util.List<CodeableConcept> getReasonCode()
Describes the reason for the guidance response in coded or textual form.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getReasonReference
public java.util.List<Reference> getReasonReference()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getNote
public java.util.List<Annotation> getNote()
Provides a mechanism to communicate additional information about the response.- Returns:
- An unmodifiable list containing immutable objects of type
Annotation
that may be empty.
-
getEvaluationMessage
public java.util.List<Reference> getEvaluationMessage()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getOutputParameters
public Reference getOutputParameters()
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.- Returns:
- An immutable object of type
Reference
that may be null.
-
getResult
public Reference getResult()
The actions, if any, produced by the evaluation of the artifact.- Returns:
- An immutable object of type
Reference
that may be null.
-
getDataRequirement
public java.util.List<DataRequirement> getDataRequirement()
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.- Returns:
- An unmodifiable list containing immutable objects of type
DataRequirement
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public GuidanceResponse.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static GuidanceResponse.Builder builder()
-
-