Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TCodeSystem

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TCodeSystem = class(TMetadataResource)

Description

The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content. 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 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 caseSensitive : boolean read GetcaseSensitive write SetcaseSensitive;
Public property caseSensitiveElement : Tboolean read GetcaseSensitiveElement write SetcaseSensitiveElement;
Public property valueSet : string read GetvalueSet write SetvalueSet;
Public property valueSetElement : Tcanonical read GetvalueSetElement write SetvalueSetElement;
Public property hierarchyMeaning : string read GethierarchyMeaning write SethierarchyMeaning;
Public property hierarchyMeaningElement : TCodeSystemHierarchyMeaning read GethierarchyMeaningElement write SethierarchyMeaningElement;
Public property compositional : boolean read Getcompositional write Setcompositional;
Public property compositionalElement : Tboolean read GetcompositionalElement write SetcompositionalElement;
Public property versionNeeded : boolean read GetversionNeeded write SetversionNeeded;
Public property versionNeededElement : Tboolean read GetversionNeededElement write SetversionNeededElement;
Public property content : string read Getcontent write Setcontent;
Public property contentElement : TCodeSystemContentMode read GetcontentElement write SetcontentElement;
Public property supplements : string read Getsupplements write Setsupplements;
Public property supplementsElement : Tcanonical read GetsupplementsElement write SetsupplementsElement;
Public property count : Int64 read Getcount write Setcount;
Public property countElement : TunsignedInt read GetcountElement write SetcountElement;
Public property filter : TCodeSystemFilterArray read GetfilterArray;
Public property property_ : TCodeSystemPropertyArray read Getproperty_Array;
Public property concept : TCodeSystemConceptArray read GetconceptArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

An absolute URI that is used to identify this code system 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 code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.

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

A formal identifier that is used to identify this code system 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 code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system 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. This is used in [Coding](datatypes.html#Coding).version.

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 CodeSystem 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 CodeSystem 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 code system. 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 code system.

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

The status of this code system. 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 code system 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 code system 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 code system 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 code system.

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 code system 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 code system instances.

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

A legal or geographic region in which the code system is intended to be used.

Public property purpose : string read Getpurpose write Setpurpose;

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

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 CodeSystem content was or is planned to be in active use.

Public property topic : TCodeableConceptArray read GettopicArray;

Descriptions related to the content of the CodeSystem. Topics provide a high-level categorization as well as keywords for the CodeSystem 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 CodeSystem.

Public property editor : TContactDetailArray read GeteditorArray;

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

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

Public property endorser : TContactDetailArray read GetendorserArray;

An individual or organization asserted by the publisher to be responsible for officially endorsing the CodeSystem 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 caseSensitive : boolean read GetcaseSensitive write SetcaseSensitive;

If code comparison is case sensitive when codes within this system are compared to each other.

Public property caseSensitiveElement : Tboolean read GetcaseSensitiveElement write SetcaseSensitiveElement;
 
Public property valueSet : string read GetvalueSet write SetvalueSet;

Canonical reference to the value set that contains all codes in the code system independent of code status.

Public property valueSetElement : Tcanonical read GetvalueSetElement write SetvalueSetElement;
 
Public property hierarchyMeaning : string read GethierarchyMeaning write SethierarchyMeaning;

The meaning of the hierarchy of concepts as represented in this resource.

Public property hierarchyMeaningElement : TCodeSystemHierarchyMeaning read GethierarchyMeaningElement write SethierarchyMeaningElement;
 
Public property compositional : boolean read Getcompositional write Setcompositional;

The code system defines a compositional (post-coordination) grammar.

Public property compositionalElement : Tboolean read GetcompositionalElement write SetcompositionalElement;
 
Public property versionNeeded : boolean read GetversionNeeded write SetversionNeeded;

This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.

Public property versionNeededElement : Tboolean read GetversionNeededElement write SetversionNeededElement;
 
Public property content : string read Getcontent write Setcontent;

The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

Public property contentElement : TCodeSystemContentMode read GetcontentElement write SetcontentElement;
 
Public property supplements : string read Getsupplements write Setsupplements;

The canonical URL of the code system that this code system supplement is adding designations and properties to.

Public property supplementsElement : Tcanonical read GetsupplementsElement write SetsupplementsElement;
 
Public property count : Int64 read Getcount write Setcount;

The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.

Public property countElement : TunsignedInt read GetcountElement write SetcountElement;
 
Public property filter : TCodeSystemFilterArray read GetfilterArray;

A filter that can be used in a value set compose statement when selecting concepts using a filter.

Public property property_ : TCodeSystemPropertyArray read Getproperty_Array;

A property defines an additional slot through which additional information can be provided about a concept.

Public property concept : TCodeSystemConceptArray read GetconceptArray;

Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.

Generated by PasDoc 0.15.0.