Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TSearchParameter

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TSearchParameter = class(TCanonicalResource)

Description

A search parameter that defines a named search item that can be used to search/filter on a resource. 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 derivedFrom : string read GetderivedFrom write SetderivedFrom;
Public property derivedFromElement : Tcanonical read GetderivedFromElement write SetderivedFromElement;
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 code : string read Getcode write Setcode;
Public property codeElement : Tcode read GetcodeElement write SetcodeElement;
Public property base : TBSFHIRPrimitiveStringArray read GetbaseArray;
Public property type_ : string read Gettype_ write Settype_;
Public property type_Element : TSearchParamType read Gettype_Element write Settype_Element;
Public property expression : string read Getexpression write Setexpression;
Public property expressionElement : Tstring read GetexpressionElement write SetexpressionElement;
Public property processingMode : string read GetprocessingMode write SetprocessingMode;
Public property processingModeElement : TSearchProcessingModeType read GetprocessingModeElement write SetprocessingModeElement;
Public property constraint : string read Getconstraint write Setconstraint;
Public property constraintElement : Tstring read GetconstraintElement write SetconstraintElement;
Public property target : TBSFHIRPrimitiveStringArray read GettargetArray;
Public property multipleOr : boolean read GetmultipleOr write SetmultipleOr;
Public property multipleOrElement : Tboolean read GetmultipleOrElement write SetmultipleOrElement;
Public property multipleAnd : boolean read GetmultipleAnd write SetmultipleAnd;
Public property multipleAndElement : Tboolean read GetmultipleAndElement write SetmultipleAndElement;
Public property comparator : TBSFHIRPrimitiveStringArray read GetcomparatorArray;
Public property modifier : TBSFHIRPrimitiveStringArray read GetmodifierArray;
Public property chain : TBSFHIRPrimitiveStringArray read GetchainArray;
Public property component : TSearchParameterComponentArray read GetcomponentArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

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

Public property titleElement : Tstring read GettitleElement write SettitleElement;
 
Public property derivedFrom : string read GetderivedFrom write SetderivedFrom;

Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.

Public property derivedFromElement : Tcanonical read GetderivedFromElement write SetderivedFromElement;
 
Public property status : string read Getstatus write Setstatus;

The status of this search parameter. 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 search parameter 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 search parameter 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 search parameter 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 tresponsible for the release and ongoing maintenance of the search parameter.

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;

And how it used.

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 search parameter instances.

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

A legal or geographic region in which the search parameter is intended to be used.

Public property purpose : string read Getpurpose write Setpurpose;

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

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 code : string read Getcode write Setcode;

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

Public property codeElement : Tcode read GetcodeElement write SetcodeElement;
 
Public property base : TBSFHIRPrimitiveStringArray read GetbaseArray;

The base resource type(s) that this search parameter can be used against.

Public property type_ : string read Gettype_ write Settype_;

The type of value that a search parameter may contain, and how the content is interpreted.

Public property type_Element : TSearchParamType read Gettype_Element write Settype_Element;
 
Public property expression : string read Getexpression write Setexpression;

A FHIRPath expression that returns a set of elements for the search parameter.

Public property expressionElement : Tstring read GetexpressionElement write SetexpressionElement;
 
Public property processingMode : string read GetprocessingMode write SetprocessingMode;

How the search parameter relates to the set of elements returned by evaluating the expression query.

Public property processingModeElement : TSearchProcessingModeType read GetprocessingModeElement write SetprocessingModeElement;
 
Public property constraint : string read Getconstraint write Setconstraint;

FHIRPath expression that defines/sets a complex constraint for when this SearchParameter is applicable.

Public property constraintElement : Tstring read GetconstraintElement write SetconstraintElement;
 
Public property target : TBSFHIRPrimitiveStringArray read GettargetArray;

Types of resource (if a resource is referenced).

Public property multipleOr : boolean read GetmultipleOr write SetmultipleOr;

Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.

Public property multipleOrElement : Tboolean read GetmultipleOrElement write SetmultipleOrElement;
 
Public property multipleAnd : boolean read GetmultipleAnd write SetmultipleAnd;

Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.

Public property multipleAndElement : Tboolean read GetmultipleAndElement write SetmultipleAndElement;
 
Public property comparator : TBSFHIRPrimitiveStringArray read GetcomparatorArray;

Comparators supported for the search parameter.

Public property modifier : TBSFHIRPrimitiveStringArray read GetmodifierArray;

A modifier supported for the search parameter.

Public property chain : TBSFHIRPrimitiveStringArray read GetchainArray;

Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.

Public property component : TSearchParameterComponentArray read GetcomponentArray;

Used to define the parts of a composite search parameter.

Generated by PasDoc 0.15.0.