Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TSubscriptionTopic

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r4b

Declaration

type TSubscriptionTopic = class(TDomainResource)

Description

Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic. 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 url : string read Geturl write Seturl;
Public property urlElement : Turi read GeturlElement write SeturlElement;
Public property identifier : TIdentifierArray read GetidentifierArray;
Public property version : string read Getversion write Setversion;
Public property versionElement : Tstring read GetversionElement write SetversionElement;
Public property title : string read Gettitle write Settitle;
Public property titleElement : Tstring read GettitleElement write SettitleElement;
Public property derivedFrom : TBSFHIRPrimitiveStringArray read GetderivedFromArray;
Public property status : string read Getstatus write Setstatus;
Public property statusElement : TPublicationStatus read GetstatusElement write SetstatusElement;
Public property experimental : boolean read Getexperimental write Setexperimental;
Public property experimentalElement : Tboolean read GetexperimentalElement write SetexperimentalElement;
Public property date_ : string read Getdate_ write Setdate_;
Public property date_Element : TdateTime_ read Getdate_Element write Setdate_Element;
Public property publisher : string read Getpublisher write Setpublisher;
Public property publisherElement : Tstring read GetpublisherElement write SetpublisherElement;
Public property contact : TContactDetailArray read GetcontactArray;
Public property description : string read Getdescription write Setdescription;
Public property descriptionElement : Tmarkdown read GetdescriptionElement write SetdescriptionElement;
Public property useContext : TUsageContextArray read GetuseContextArray;
Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;
Public property purpose : string read Getpurpose write Setpurpose;
Public property purposeElement : Tmarkdown read GetpurposeElement write SetpurposeElement;
Public property copyright : string read Getcopyright write Setcopyright;
Public property copyrightElement : Tmarkdown read GetcopyrightElement write SetcopyrightElement;
Public property approvalDate : string read GetapprovalDate write SetapprovalDate;
Public property approvalDateElement : Tdate_ read GetapprovalDateElement write SetapprovalDateElement;
Public property lastReviewDate : string read GetlastReviewDate write SetlastReviewDate;
Public property lastReviewDateElement : Tdate_ read GetlastReviewDateElement write SetlastReviewDateElement;
Public property effectivePeriod : TPeriod read GeteffectivePeriod write SeteffectivePeriod;
Public property resourceTrigger : TSubscriptionTopicResourceTriggerArray read GetresourceTriggerArray;
Public property eventTrigger : TSubscriptionTopicEventTriggerArray read GeteventTriggerArray;
Public property canFilterBy : TSubscriptionTopicCanFilterByArray read GetcanFilterByArray;
Public property notificationShape : TSubscriptionTopicNotificationShapeArray read GetnotificationShapeArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

An absolute URI that is used to identify this subscription topic when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers.

Public property urlElement : Turi read GeturlElement write SeturlElement;
 
Public property identifier : TIdentifierArray read GetidentifierArray;

Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

Public property version : string read Getversion write Setversion;

The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.

Public property versionElement : Tstring read GetversionElement write SetversionElement;
 
Public property title : string read Gettitle write Settitle;

A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".

Public property titleElement : Tstring read GettitleElement write SettitleElement;
 
Public property derivedFrom : TBSFHIRPrimitiveStringArray read GetderivedFromArray;

The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.

Public property status : string read Getstatus write Setstatus;

The current state of the SubscriptionTopic.

Public property statusElement : TPublicationStatus read GetstatusElement write SetstatusElement;
 
Public property experimental : boolean read Getexperimental write Setexperimental;

A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Public property experimentalElement : Tboolean read GetexperimentalElement write SetexperimentalElement;
 
Public property date_ : string read Getdate_ write Setdate_;

For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.

Public property date_Element : TdateTime_ read Getdate_Element write Setdate_Element;
 
Public property publisher : string read Getpublisher write Setpublisher;

Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.

Public property publisherElement : Tstring read GetpublisherElement write SetpublisherElement;
 
Public property contact : TContactDetailArray read GetcontactArray;

Contact details to assist a user in finding and communicating with the publisher.

Public property description : string read Getdescription write Setdescription;

A free text natural language description of the Topic from the consumer's perspective.

Public property descriptionElement : Tmarkdown read GetdescriptionElement write SetdescriptionElement;
 
Public property useContext : TUsageContextArray read GetuseContextArray;

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

A jurisdiction in which the Topic is intended to be used.

Public property purpose : string read Getpurpose write Setpurpose;

Explains why this Topic is needed and why it has been designed as it has.

Public property purposeElement : Tmarkdown read GetpurposeElement write SetpurposeElement;
 
Public property copyright : string read Getcopyright write Setcopyright;

A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.

Public property copyrightElement : Tmarkdown read GetcopyrightElement write SetcopyrightElement;
 
Public property approvalDate : string read GetapprovalDate write SetapprovalDate;

The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Public property approvalDateElement : Tdate_ read GetapprovalDateElement write SetapprovalDateElement;
 
Public property lastReviewDate : string read GetlastReviewDate write SetlastReviewDate;

The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

Public property lastReviewDateElement : Tdate_ read GetlastReviewDateElement write SetlastReviewDateElement;
 
Public property effectivePeriod : TPeriod read GeteffectivePeriod write SeteffectivePeriod;

The period during which the SubscriptionTopic content was or is planned to be effective.

Public property resourceTrigger : TSubscriptionTopicResourceTriggerArray read GetresourceTriggerArray;

A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).

Public property eventTrigger : TSubscriptionTopicEventTriggerArray read GeteventTriggerArray;

Event definition which can be used to trigger the SubscriptionTopic.

Public property canFilterBy : TSubscriptionTopicCanFilterByArray read GetcanFilterByArray;

List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).

Public property notificationShape : TSubscriptionTopicNotificationShapeArray read GetnotificationShapeArray;

List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.

Generated by PasDoc 0.15.0.