Class TSubscriptionChannel

Unit

bsFhir_r4

Declaration

type TSubscriptionChannel = class(TBackboneElement)

Description

The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

Hierarchy

• TBSTypedObject
• TBSFHIRValue
• TBSFHIRObject
• TBase
• TElement
• TBackboneElement
• TSubscriptionChannel

Overview

Methods

constructor Create; override;

Properties

	property type_ : string read Gettype_ write Settype_;
	property type_Element : TSubscriptionChannelType read Gettype_Element write Settype_Element;
	property endpoint : string read Getendpoint write Setendpoint;
	property endpointElement : Turl read GetendpointElement write SetendpointElement;
	property payload : string read Getpayload write Setpayload;
	property payloadElement : Tcode read GetpayloadElement write SetpayloadElement;
	property header : TBSFHIRPrimitiveStringArray read GetheaderArray;

Description

Methods

	constructor Create; override;

Properties

	property type_ : string read Gettype_ write Settype_;
The type of channel to send notifications on.

	property type_Element : TSubscriptionChannelType read Gettype_Element write Settype_Element;

	property endpoint : string read Getendpoint write Setendpoint;
The url that describes the actual end-point to send messages to.

	property endpointElement : Turl read GetendpointElement write SetendpointElement;

	property payload : string read Getpayload write Setpayload;
The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.

	property payloadElement : Tcode read GetpayloadElement write SetpayloadElement;

	property header : TBSFHIRPrimitiveStringArray read GetheaderArray;
Additional headers / information to send as part of the notification.