Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TSubscription

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TSubscription = class(TDomainResource)

Description

The subscription resource describes a particular client's request to be notified about a SubscriptionTopic. 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 identifier : TIdentifierArray read GetidentifierArray;
Public property name_ : string read Getname_ write Setname_;
Public property name_Element : Tstring read Getname_Element write Setname_Element;
Public property status : string read Getstatus write Setstatus;
Public property statusElement : TSubscriptionStatusCodes read GetstatusElement write SetstatusElement;
Public property topic : string read Gettopic write Settopic;
Public property topicElement : Tcanonical read GettopicElement write SettopicElement;
Public property contact : TContactPointArray read GetcontactArray;
Public property end_ : string read Getend_ write Setend_;
Public property end_Element : Tinstant read Getend_Element write Setend_Element;
Public property managingEntity : TReference read GetmanagingEntity write SetmanagingEntity;
Public property reason : string read Getreason write Setreason;
Public property reasonElement : Tstring read GetreasonElement write SetreasonElement;
Public property filterBy : TSubscriptionFilterByArray read GetfilterByArray;
Public property channelType : TCoding read GetchannelType write SetchannelType;
Public property endpoint : string read Getendpoint write Setendpoint;
Public property endpointElement : Turl read GetendpointElement write SetendpointElement;
Public property parameter : TSubscriptionParameterArray read GetparameterArray;
Public property heartbeatPeriod : Int64 read GetheartbeatPeriod write SetheartbeatPeriod;
Public property heartbeatPeriodElement : TunsignedInt read GetheartbeatPeriodElement write SetheartbeatPeriodElement;
Public property timeout : Int64 read Gettimeout write Settimeout;
Public property timeoutElement : TunsignedInt read GettimeoutElement write SettimeoutElement;
Public property contentType : string read GetcontentType write SetcontentType;
Public property contentTypeElement : Tcode read GetcontentTypeElement write SetcontentTypeElement;
Public property content : string read Getcontent write Setcontent;
Public property contentElement : TSubscriptionPayloadContent read GetcontentElement write SetcontentElement;
Public property maxCount : Int64 read GetmaxCount write SetmaxCount;
Public property maxCountElement : TpositiveInt read GetmaxCountElement write SetmaxCountElement;

Description

Methods

Public constructor Create; override;
 

Properties

Public property identifier : TIdentifierArray read GetidentifierArray;

A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.

Public property name_ : string read Getname_ write Setname_;

A natural language name identifying the subscription.

Public property name_Element : Tstring read Getname_Element write Setname_Element;
 
Public property status : string read Getstatus write Setstatus;

The status of the subscription, which marks the server state for managing the subscription.

Public property statusElement : TSubscriptionStatusCodes read GetstatusElement write SetstatusElement;
 
Public property topic : string read Gettopic write Settopic;

The reference to the subscription topic to be notified about.

Public property topicElement : Tcanonical read GettopicElement write SettopicElement;
 
Public property contact : TContactPointArray read GetcontactArray;

Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

Public property end_ : string read Getend_ write Setend_;

The time for the server to turn the subscription off.

Public property end_Element : Tinstant read Getend_Element write Setend_Element;
 
Public property managingEntity : TReference read GetmanagingEntity write SetmanagingEntity;

Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.

Public property reason : string read Getreason write Setreason;

A description of why this subscription is defined.

Public property reasonElement : Tstring read GetreasonElement write SetreasonElement;
 
Public property filterBy : TSubscriptionFilterByArray read GetfilterByArray;

The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND).

Public property channelType : TCoding read GetchannelType write SetchannelType;

The type of channel to send notifications on.

Public property endpoint : string read Getendpoint write Setendpoint;

The url that describes the actual end-point to send notifications to.

Public property endpointElement : Turl read GetendpointElement write SetendpointElement;
 
Public property parameter : TSubscriptionParameterArray read GetparameterArray;

Channel-dependent information to send as part of the notification (e.g., HTTP Headers).

Public property heartbeatPeriod : Int64 read GetheartbeatPeriod write SetheartbeatPeriod;

If present, a 'heartbeat' notification (keep-alive) is sent via this channel with an interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.

Public property heartbeatPeriodElement : TunsignedInt read GetheartbeatPeriodElement write SetheartbeatPeriodElement;
 
Public property timeout : Int64 read Gettimeout write Settimeout;

If present, the maximum amount of time a server will allow before failing a notification attempt.

Public property timeoutElement : TunsignedInt read GettimeoutElement write SettimeoutElement;
 
Public property contentType : string read GetcontentType write SetcontentType;

The MIME type to send the payload in - e.g., `application/fhir+xml` or `application/fhir+json`. Note that:

* clients may request notifications in a specific FHIR version by using the [FHIR Version Parameter](http.html#version-parameter) - e.g., `application/fhir+json; fhirVersion=4.0`.

* additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html` are defined by the Email channel.

Public property contentTypeElement : Tcode read GetcontentTypeElement write SetcontentTypeElement;
 
Public property content : string read Getcontent write Setcontent;

How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.

Public property contentElement : TSubscriptionPayloadContent read GetcontentElement write SetcontentElement;
 
Public property maxCount : Int64 read GetmaxCount write SetmaxCount;

If present, the maximum number of events that will be included in a notification bundle. Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.

Public property maxCountElement : TpositiveInt read GetmaxCountElement write SetmaxCountElement;
 
Generated by PasDoc 0.15.0.