Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TOperationDefinition

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TOperationDefinition = class(TCanonicalResource)

Description

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction). 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 kind : string read Getkind write Setkind;
Public property kindElement : TOperationKind read GetkindElement write SetkindElement;
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 affectsState : boolean read GetaffectsState write SetaffectsState;
Public property affectsStateElement : Tboolean read GetaffectsStateElement write SetaffectsStateElement;
Public property code : string read Getcode write Setcode;
Public property codeElement : Tcode read GetcodeElement write SetcodeElement;
Public property comment : string read Getcomment write Setcomment;
Public property commentElement : Tmarkdown read GetcommentElement write SetcommentElement;
Public property base : string read Getbase write Setbase;
Public property baseElement : Tcanonical read GetbaseElement write SetbaseElement;
Public property resource : TBSFHIRPrimitiveStringArray read GetresourceArray;
Public property system : boolean read Getsystem write Setsystem;
Public property systemElement : Tboolean read GetsystemElement write SetsystemElement;
Public property type_ : boolean read Gettype_ write Settype_;
Public property type_Element : Tboolean read Gettype_Element write Settype_Element;
Public property instance : boolean read Getinstance write Setinstance;
Public property instanceElement : Tboolean read GetinstanceElement write SetinstanceElement;
Public property inputProfile : string read GetinputProfile write SetinputProfile;
Public property inputProfileElement : Tcanonical read GetinputProfileElement write SetinputProfileElement;
Public property outputProfile : string read GetoutputProfile write SetoutputProfile;
Public property outputProfileElement : Tcanonical read GetoutputProfileElement write SetoutputProfileElement;
Public property parameter : TOperationDefinitionParameterArray read GetparameterArray;
Public property overload : TOperationDefinitionOverloadArray read GetoverloadArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

An absolute URI that is used to identify this operation 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 operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation 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 implementation guide 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 operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation 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 operation 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 operation definition.

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

The current state of this operation definition.

Public property statusElement : TPublicationStatus read GetstatusElement write SetstatusElement;
 
Public property kind : string read Getkind write Setkind;

Whether this is an operation or a named query.

Public property kindElement : TOperationKind read GetkindElement write SetkindElement;
 
Public property experimental : boolean read Getexperimental write Setexperimental;

A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended 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 operation 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 operation 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 operation 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 operation definition from a 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 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 operation definition.

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

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

Public property purpose : string read Getpurpose write Setpurpose;

Explanation of why this operation 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 operation definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the operation 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 affectsState : boolean read GetaffectsState write SetaffectsState;

Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.

Public property affectsStateElement : Tboolean read GetaffectsStateElement write SetaffectsStateElement;
 
Public property code : string read Getcode write Setcode;

The label that is recommended to be used in the URL for this operation. In some cases, servers may need to use a different CapabilityStatement operation.name to differentiate between multiple SearchParameters that happen to have the same code.

Public property codeElement : Tcode read GetcodeElement write SetcodeElement;
 
Public property comment : string read Getcomment write Setcomment;

Additional information about how to use this operation or named query.

Public property commentElement : Tmarkdown read GetcommentElement write SetcommentElement;
 
Public property base : string read Getbase write Setbase;

Indicates that this operation definition is a constraining profile on the base.

Public property baseElement : Tcanonical read GetbaseElement write SetbaseElement;
 
Public property resource : TBSFHIRPrimitiveStringArray read GetresourceArray;

The types on which this operation can be executed.

Public property system : boolean read Getsystem write Setsystem;

Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).

Public property systemElement : Tboolean read GetsystemElement write SetsystemElement;
 
Public property type_ : boolean read Gettype_ write Settype_;

Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).

Public property type_Element : Tboolean read Gettype_Element write Settype_Element;
 
Public property instance : boolean read Getinstance write Setinstance;

Indicates whether this operation can be invoked on a particular instance of one of the given types.

Public property instanceElement : Tboolean read GetinstanceElement write SetinstanceElement;
 
Public property inputProfile : string read GetinputProfile write SetinputProfile;

Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.

Public property inputProfileElement : Tcanonical read GetinputProfileElement write SetinputProfileElement;
 
Public property outputProfile : string read GetoutputProfile write SetoutputProfile;

Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.

Public property outputProfileElement : Tcanonical read GetoutputProfileElement write SetoutputProfileElement;
 
Public property parameter : TOperationDefinitionParameterArray read GetparameterArray;

The parameters for the operation/query.

Public property overload : TOperationDefinitionOverloadArray read GetoverloadArray;

Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

Generated by PasDoc 0.15.0.