Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TActorDefinition

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TActorDefinition = class(TCanonicalResource)

Description

Describes an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays. 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 versionAlgorithmString : string read GetversionAlgorithmString write SetversionAlgorithmString;
Public property versionAlgorithmStringElement : Tstring read GetversionAlgorithmStringElement write SetversionAlgorithmStringElement;
Public property versionAlgorithmCoding : TCoding read GetversionAlgorithmCoding write SetversionAlgorithmCoding;
Public property name_ : string read Getname_ write Setname_;
Public property name_Element : Tstring read Getname_Element write Setname_Element;
Public property title : string read Gettitle write Settitle;
Public property titleElement : Tstring read GettitleElement write SettitleElement;
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 copyrightLabel : string read GetcopyrightLabel write SetcopyrightLabel;
Public property copyrightLabelElement : Tstring read GetcopyrightLabelElement write SetcopyrightLabelElement;
Public property type_ : string read Gettype_ write Settype_;
Public property type_Element : TExampleScenarioActorType read Gettype_Element write Settype_Element;
Public property documentation : string read Getdocumentation write Setdocumentation;
Public property documentationElement : Tmarkdown read GetdocumentationElement write SetdocumentationElement;
Public property reference : TBSFHIRPrimitiveStringArray read GetreferenceArray;
Public property capabilities : string read Getcapabilities write Setcapabilities;
Public property capabilitiesElement : Tcanonical read GetcapabilitiesElement write SetcapabilitiesElement;
Public property derivedFrom : TBSFHIRPrimitiveStringArray read GetderivedFromArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

An absolute URI that is used to identify this actor definition 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 an authoritative instance of this actor definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the actor definition is stored on different servers.

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

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

Public property version : string read Getversion write Setversion;

The identifier that is used to identify this version of the actor definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the actor definition 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 can be placed in a lexicographical sequence.

Public property versionElement : Tstring read GetversionElement write SetversionElement;
 
Public property versionAlgorithmString : string read GetversionAlgorithmString write SetversionAlgorithmString;

Indicates the mechanism used to compare versions to determine which is more current. (choose any one of versionAlgorithm*, but only one)

Public property versionAlgorithmStringElement : Tstring read GetversionAlgorithmStringElement write SetversionAlgorithmStringElement;
 
Public property versionAlgorithmCoding : TCoding read GetversionAlgorithmCoding write SetversionAlgorithmCoding;

Indicates the mechanism used to compare versions to determine which is more current. (choose any one of versionAlgorithm*, but only one)

Public property name_ : string read Getname_ write Setname_;

A natural language name identifying the actor definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Public property name_Element : Tstring read Getname_Element write Setname_Element;
 
Public property title : string read Gettitle write Settitle;

A short, descriptive, user-friendly title for the actor definition.

Public property titleElement : Tstring read GettitleElement write SettitleElement;
 
Public property status : string read Getstatus write Setstatus;

The status of this actor definition. Enables tracking the life-cycle of the content.

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

A Boolean value to indicate that this actor definition 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_;

The date (and optionally time) when the actor definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the actor definition changes.

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

The name of the organization or individual responsible for the release and ongoing maintenance of the actor definition.

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 actor.

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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate actor definition instances.

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

A legal or geographic region in which the actor definition is intended to be used.

Public property purpose : string read Getpurpose write Setpurpose;

Explanation of why this actor definition 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 actor definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the actor definition.

Public property copyrightElement : Tmarkdown read GetcopyrightElement write SetcopyrightElement;
 
Public property copyrightLabel : string read GetcopyrightLabel write SetcopyrightLabel;

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Public property copyrightLabelElement : Tstring read GetcopyrightLabelElement write SetcopyrightLabelElement;
 
Public property type_ : string read Gettype_ write Settype_;

Whether the actor represents a human or an appliction.

Public property type_Element : TExampleScenarioActorType read Gettype_Element write Settype_Element;
 
Public property documentation : string read Getdocumentation write Setdocumentation;

Documentation about the functionality of the actor.

Public property documentationElement : Tmarkdown read GetdocumentationElement write SetdocumentationElement;
 
Public property reference : TBSFHIRPrimitiveStringArray read GetreferenceArray;

A reference to additional documentation about the actor, but description and documentation.

Public property capabilities : string read Getcapabilities write Setcapabilities;

The capability statement for the actor (if the concept is applicable).

Public property capabilitiesElement : Tcanonical read GetcapabilitiesElement write SetcapabilitiesElement;
 
Public property derivedFrom : TBSFHIRPrimitiveStringArray read GetderivedFromArray;

A url that identifies the definition of this actor in another IG (which IG must be listed in the dependencies). This actor inherits all the obligations etc. as defined in the other IG.

Generated by PasDoc 0.15.0.