Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TValueSet

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TValueSet = class(TMetadataResource)

Description

A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem](codesystem.html) definitions and their use in [coded elements](terminologies.html). 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 immutable : boolean read Getimmutable write Setimmutable;
Public property immutableElement : Tboolean read GetimmutableElement write SetimmutableElement;
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 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 topic : TCodeableConceptArray read GettopicArray;
Public property author : TContactDetailArray read GetauthorArray;
Public property editor : TContactDetailArray read GeteditorArray;
Public property reviewer : TContactDetailArray read GetreviewerArray;
Public property endorser : TContactDetailArray read GetendorserArray;
Public property relatedArtifact : TRelatedArtifactArray read GetrelatedArtifactArray;
Public property compose : TValueSetCompose read Getcompose write Setcompose;
Public property expansion : TValueSetExpansion read Getexpansion write Setexpansion;
Public property scope : TValueSetScope read Getscope write Setscope;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

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

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

The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.

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

A Boolean value to indicate that this value set 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 value set metadata or content logical definition (.compose) was created or revised.

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 value set.

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 value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.

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 value set instances.

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

A legal or geographic region in which the value set is intended to be used.

Public property immutable : boolean read Getimmutable write Setimmutable;

If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.

Public property immutableElement : Tboolean read GetimmutableElement write SetimmutableElement;
 
Public property purpose : string read Getpurpose write Setpurpose;

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

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 approvalDate : string read GetapprovalDate write SetapprovalDate;

The date on which the resource 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 resource content was last reviewed. Review happens periodically after approval but does not 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 ValueSet content was or is planned to be in active use.

Public property topic : TCodeableConceptArray read GettopicArray;

Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching.

Public property author : TContactDetailArray read GetauthorArray;

An individiual or organization primarily involved in the creation and maintenance of the ValueSet.

Public property editor : TContactDetailArray read GeteditorArray;

An individual or organization primarily responsible for internal coherence of the ValueSet.

Public property reviewer : TContactDetailArray read GetreviewerArray;

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet.

Public property endorser : TContactDetailArray read GetendorserArray;

An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting.

Public property relatedArtifact : TRelatedArtifactArray read GetrelatedArtifactArray;

Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

Public property compose : TValueSetCompose read Getcompose write Setcompose;

A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).

Public property expansion : TValueSetExpansion read Getexpansion write Setexpansion;

A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

Public property scope : TValueSetScope read Getscope write Setscope;

Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.

Generated by PasDoc 0.15.0.