Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TGuidanceResponse

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_stu3

Declaration

type TGuidanceResponse = class(TDomainResource)

Description

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

Hierarchy

Overview

Methods

Public constructor Create; override;

Properties

Public property requestId : string read GetrequestId write SetrequestId;
Public property requestIdElement : Tid read GetrequestIdElement write SetrequestIdElement;
Public property identifier : TIdentifier read Getidentifier write Setidentifier;
Public property module : TReference read Getmodule write Setmodule;
Public property status : string read Getstatus write Setstatus;
Public property statusElement : TGuidanceResponseStatus read GetstatusElement write SetstatusElement;
Public property subject : TReference read Getsubject write Setsubject;
Public property context : TReference read Getcontext write Setcontext;
Public property occurrenceDateTime : string read GetoccurrenceDateTime write SetoccurrenceDateTime;
Public property occurrenceDateTimeElement : TdateTime_ read GetoccurrenceDateTimeElement write SetoccurrenceDateTimeElement;
Public property performer : TReference read Getperformer write Setperformer;
Public property reason : TElement read Getreason write Setreason;
Public property note : TAnnotationArray read GetnoteArray;
Public property evaluationMessage : TReferenceArray read GetevaluationMessageArray;
Public property outputParameters : TReference read GetoutputParameters write SetoutputParameters;
Public property result : TReference read Getresult write Setresult;
Public property dataRequirement : TDataRequirementArray read GetdataRequirementArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property requestId : string read GetrequestId write SetrequestId;

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 property requestIdElement : Tid read GetrequestIdElement write SetrequestIdElement;
 
Public property identifier : TIdentifier read Getidentifier write Setidentifier;

Allows a service to provide a unique, business identifier for the response.

Public property module : TReference read Getmodule write Setmodule;

A reference to the knowledge module that was invoked.

Public property status : string read Getstatus write Setstatus;

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 property statusElement : TGuidanceResponseStatus read GetstatusElement write SetstatusElement;
 
Public property subject : TReference read Getsubject write Setsubject;

The patient for which the request was processed.

Public property context : TReference read Getcontext write Setcontext;

Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.

Public property occurrenceDateTime : string read GetoccurrenceDateTime write SetoccurrenceDateTime;

Indicates when the guidance response was processed.

Public property occurrenceDateTimeElement : TdateTime_ read GetoccurrenceDateTimeElement write SetoccurrenceDateTimeElement;
 
Public property performer : TReference read Getperformer write Setperformer;

Provides a reference to the device that performed the guidance.

Public property reason : TElement read Getreason write Setreason;

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 property note : TAnnotationArray read GetnoteArray;

Provides a mechanism to communicate additional information about the response.

Public property evaluationMessage : TReferenceArray read GetevaluationMessageArray;

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 property outputParameters : TReference read GetoutputParameters write SetoutputParameters;

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 property result : TReference read Getresult write Setresult;

The actions, if any, produced by the evaluation of the artifact.

Public property dataRequirement : TDataRequirementArray read GetdataRequirementArray;

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.

Generated by PasDoc 0.15.0.