
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
static class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List<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
The encounter during which this response was created or to which the creation of this record is tightly associated.Messages resulting from the evaluation of the artifact or artifacts.protected List<Identifier>
Allows a service to provide unique, business identifiers for the response.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected DataType
An identifier, CodeableConcept or canonical reference to the guidance that was requested.protected List<Annotation>
Provides a mechanism to communicate additional information about the response.protected DateTimeType
Indicates when the guidance response was processed.protected Reference
The output parameters of the evaluation, if any.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected Reference
Provides a reference to the device that performed the guidance.protected List<CodeableReference>
Describes the reason for the guidance response in coded or textual form, or Indicates the reason the request was initiated.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for requestprotected Identifier
The identifier of the request associated with this response.protected Reference
The actions, if any, produced by the evaluation of the artifact.static final String
Search parameter: identifierstatic final String
Search parameter: patientstatic final String
Search parameter: requeststatic final String
Search parameter: statusstatic final String
Search parameter: subjectThe status of the response.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Reference
The patient for which the request was processed.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorGuidanceResponse
(DataType module, GuidanceResponse.GuidanceResponseStatus status) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddNote()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setDataRequirement
(List<DataRequirement> theDataRequirement) setEncounter
(Reference value) setEvaluationMessage
(List<Reference> theEvaluationMessage) setIdentifier
(List<Identifier> theIdentifier) setNote
(List<Annotation> theNote) setOccurrenceDateTime
(Date value) setOutputParameters
(Reference value) setPerformer
(Reference value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReason
(List<CodeableReference> theReason) setRequestIdentifier
(Identifier value) setSubject
(Reference value) protected GuidanceResponse
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId
-
Field Details
-
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
Allows a service to provide unique, business identifiers for the response. -
module
An identifier, CodeableConcept or canonical reference to the guidance that was requested. -
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
The patient for which the request was processed. -
encounter
The encounter during which this response was created or to which the creation of this record is tightly associated. -
occurrenceDateTime
Indicates when the guidance response was processed. -
performer
Provides a reference to the device that performed the guidance. -
reason
Describes the reason for the guidance response in coded or textual form, or 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
Provides a mechanism to communicate additional information about the response. -
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. -
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. -
result
The actions, if any, produced by the evaluation of the artifact. -
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_IDENTIFIER
Search parameter: identifierDescription: The identifier of the guidance response
Type: token
Path: GuidanceResponse.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The identifier of the guidance response
Type: token
Path: GuidanceResponse.identifier
-
SP_PATIENT
Search parameter: patientDescription: The identity of a patient to search for guidance response results
Type: reference
Path: GuidanceResponse.subject.where(resolve() is Patient)
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The identity of a patient to search for guidance response results
Type: reference
Path: GuidanceResponse.subject.where(resolve() is Patient)
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "GuidanceResponse:patient". -
SP_REQUEST
Search parameter: requestDescription: The identifier of the request associated with the response
Type: token
Path: GuidanceResponse.requestIdentifier
- See Also:
-
REQUEST
Fluent Client search parameter constant for requestDescription: The identifier of the request associated with the response
Type: token
Path: GuidanceResponse.requestIdentifier
-
SP_STATUS
Search parameter: statusDescription: The status of the guidance response
Type: token
Path: GuidanceResponse.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The status of the guidance response
Type: token
Path: GuidanceResponse.status
-
SP_SUBJECT
Search parameter: subjectDescription: The subject that the guidance response is about
Type: reference
Path: GuidanceResponse.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The subject that the guidance response is about
Type: reference
Path: GuidanceResponse.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "GuidanceResponse:subject".
-
-
Constructor Details
-
GuidanceResponse
public GuidanceResponse()Constructor -
GuidanceResponse
Constructor
-
-
Method Details
-
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
-
setRequestIdentifier
- 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
- Returns:
identifier
(Allows a service to provide unique, business identifiers for the response.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
getModule
- Returns:
module
(An identifier, CodeableConcept or canonical reference to the guidance that was requested.)
-
getModuleUriType
- Returns:
module
(An identifier, CodeableConcept or canonical reference to the guidance that was requested.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasModuleUriType
-
getModuleCanonicalType
- Returns:
module
(An identifier, CodeableConcept or canonical reference to the guidance that was requested.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasModuleCanonicalType
-
getModuleCodeableConcept
- Returns:
module
(An identifier, CodeableConcept or canonical reference to the guidance that was requested.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasModuleCodeableConcept
-
hasModule
-
setModule
- Parameters:
value
-module
(An identifier, CodeableConcept or canonical reference to the guidance that was requested.)
-
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
-
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
- 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
- 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
- Returns:
subject
(The patient for which the request was processed.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The patient for which the request was processed.)
-
getEncounter
- Returns:
encounter
(The encounter during which this response was created or to which the creation of this record is tightly associated.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The encounter during which this response was created or to which the creation of this record is tightly associated.)
-
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
-
hasOccurrenceDateTime
-
setOccurrenceDateTimeElement
- 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
- Returns:
- Indicates when the guidance response was processed.
-
setOccurrenceDateTime
- Parameters:
value
- Indicates when the guidance response was processed.
-
getPerformer
- Returns:
performer
(Provides a reference to the device that performed the guidance.)
-
hasPerformer
-
setPerformer
- Parameters:
value
-performer
(Provides a reference to the device that performed the guidance.)
-
getReason
- Returns:
reason
(Describes the reason for the guidance response in coded or textual form, or 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.)
-
setReason
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReason
-
addReason
-
addReason
-
getReasonFirstRep
- Returns:
- The first repetition of repeating field
reason
, creating it if it does not already exist {3}
-
getNote
- Returns:
note
(Provides a mechanism to communicate additional information about the response.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist {3}
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEvaluationMessage
-
addEvaluationMessage
-
addEvaluationMessage
-
getEvaluationMessageFirstRep
- Returns:
- The first repetition of repeating field
evaluationMessage
, creating it if it does not already exist {3}
-
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
-
setOutputParameters
- 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.)
-
getResult
- Returns:
result
(The actions, if any, produced by the evaluation of the artifact.)
-
hasResult
-
setResult
- Parameters:
value
-result
(The actions, if any, produced by the evaluation of the artifact.)
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDataRequirement
-
addDataRequirement
-
addDataRequirement
-
getDataRequirementFirstRep
- Returns:
- The first repetition of repeating field
dataRequirement
, creating it if it does not already exist {3}
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-