Skip to main content

HS.FHIR.vSTU3.Model.Resource.GuidanceResponse

deprecated class HS.FHIR.vSTU3.Model.Resource.GuidanceResponse extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = GuidanceResponse;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property context as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property dataRequirement as list of HS.FHIR.vSTU3.Model.Base.DataRequirement (XMLNAME = "dataRequirement", XMLPROJECTION = "ELEMENT");
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.
Property methods: dataRequirementBuildValueArray(), dataRequirementCollectionToDisplay(), dataRequirementCollectionToOdbc(), dataRequirementDisplayToCollection(), dataRequirementGet(), dataRequirementGetObject(), dataRequirementGetObjectId(), dataRequirementGetSwizzled(), dataRequirementIsValid(), dataRequirementOdbcToCollection(), dataRequirementSet(), dataRequirementSetObject(), dataRequirementSetObjectId()
property evaluationMessage as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "evaluationMessage", XMLPROJECTION = "ELEMENT");
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.
Property methods: evaluationMessageBuildValueArray(), evaluationMessageCollectionToDisplay(), evaluationMessageCollectionToOdbc(), evaluationMessageDisplayToCollection(), evaluationMessageGet(), evaluationMessageGetObject(), evaluationMessageGetObjectId(), evaluationMessageGetSwizzled(), evaluationMessageIsValid(), evaluationMessageOdbcToCollection(), evaluationMessageSet(), evaluationMessageSetObject(), evaluationMessageSetObjectId()
property identifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Allows a service to provide a unique, business identifier for the response.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property module as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "module", XMLPROJECTION = "ELEMENT") [ Required ];
A reference to the knowledge module that was invoked.
Property methods: moduleGet(), moduleGetSwizzled(), moduleIsValid(), moduleNewObject(), moduleSet()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Provides a mechanism to communicate additional information about the response.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property occurrenceDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ELEMENT");
Indicates when the guidance response was processed.
Property methods: occurrenceDateTimeGet(), occurrenceDateTimeGetSwizzled(), occurrenceDateTimeIsValid(), occurrenceDateTimeNewObject(), occurrenceDateTimeSet()
property outputParameters as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "outputParameters", XMLPROJECTION = "ELEMENT");
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.
Property methods: outputParametersGet(), outputParametersGetSwizzled(), outputParametersIsValid(), outputParametersNewObject(), outputParametersSet()
property performer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Provides a reference to the device that performed the guidance.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property reasonCodeableConcept as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reasonCodeableConcept", XMLPROJECTION = "ELEMENT");
Property methods: reasonCodeableConceptGet(), reasonCodeableConceptGetSwizzled(), reasonCodeableConceptIsValid(), reasonCodeableConceptNewObject(), reasonCodeableConceptSet()
property reasonReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property requestId as HS.FHIR.vSTU3.Model.Datatype.Id (XMLNAME = "requestId", XMLPROJECTION = "ELEMENT");
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.
Property methods: requestIdGet(), requestIdGetSwizzled(), requestIdIsValid(), requestIdNewObject(), requestIdSet()
property result as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "result", XMLPROJECTION = "ELEMENT");
The actions, if any, produced by the evaluation of the artifact.
Property methods: resultGet(), resultGetSwizzled(), resultIsValid(), resultNewObject(), resultSet()
property status as HS.FHIR.vSTU3.Model.Base.GuidanceResponseStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
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.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
The patient for which the request was processed.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()

Methods

deprecated method SetContext(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "context" property.
deprecated method SetEvaluationMessage(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "evaluationMessage" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "identifier" property.
deprecated method SetModule(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "module" property.
deprecated method SetOccurrenceDateTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "occurrenceDateTime" property.
deprecated method SetOutputParameters(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "outputParameters" property.
deprecated method SetPerformer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "performer" property.
deprecated method SetReasonCodeableConcept(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "reasonCodeableConcept" property.
deprecated method SetReasonReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "reasonReference" property.
deprecated method SetRequestId(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "requestId" property.
deprecated method SetResult(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "result" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab