Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TCitation

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TCitation = class(TMetadataResource)

Description

The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources. 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 author : TContactDetailArray read GetauthorArray;
Public property editor : TContactDetailArray read GeteditorArray;
Public property reviewer : TContactDetailArray read GetreviewerArray;
Public property endorser : TContactDetailArray read GetendorserArray;
Public property summary : TCitationSummaryArray read GetsummaryArray;
Public property classification : TCitationClassificationArray read GetclassificationArray;
Public property note : TAnnotationArray read GetnoteArray;
Public property currentState : TCodeableConceptArray read GetcurrentStateArray;
Public property statusDate : TCitationStatusDateArray read GetstatusDateArray;
Public property relatedArtifact : TRelatedArtifactArray read GetrelatedArtifactArray;
Public property citedArtifact : TCitationCitedArtifact read GetcitedArtifact write SetcitedArtifact;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

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

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

The status of this summary. 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 citation record 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 citation record 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 citation record 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 that published the citation record.

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 citation 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 citation record instances.

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

A legal or geographic region in which the citation record is intended to be used.

Public property purpose : string read Getpurpose write Setpurpose;

Explanation of why this citation 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;

Use and/or publishing restrictions for the citation record, not for the cited artifact.

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

Public property author : TContactDetailArray read GetauthorArray;

Who authored or created the citation record.

Public property editor : TContactDetailArray read GeteditorArray;

Who edited or revised the citation record.

Public property reviewer : TContactDetailArray read GetreviewerArray;

Who reviewed the citation record.

Public property endorser : TContactDetailArray read GetendorserArray;

Who endorsed the citation record.

Public property summary : TCitationSummaryArray read GetsummaryArray;

A human-readable display of key concepts to represent the citation.

Public property classification : TCitationClassificationArray read GetclassificationArray;

The assignment to an organizing scheme.

Public property note : TAnnotationArray read GetnoteArray;

Used for general notes and annotations not coded elsewhere.

Public property currentState : TCodeableConceptArray read GetcurrentStateArray;

The status of the citation record.

Public property statusDate : TCitationStatusDateArray read GetstatusDateArray;

The state or status of the citation record paired with an effective date or period for that state.

Public property relatedArtifact : TRelatedArtifactArray read GetrelatedArtifactArray;

Artifact related to the citation record.

Public property citedArtifact : TCitationCitedArtifact read GetcitedArtifact write SetcitedArtifact;

The article or artifact being described.

Generated by PasDoc 0.15.0.