Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TPlanDefinition

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TPlanDefinition = class(TMetadataResource)

Description

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications. 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 subtitle : string read Getsubtitle write Setsubtitle;
Public property subtitleElement : Tstring read GetsubtitleElement write SetsubtitleElement;
Public property type_ : TCodeableConcept read Gettype_ write Settype_;
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 subjectCodeableConcept : TCodeableConcept read GetsubjectCodeableConcept write SetsubjectCodeableConcept;
Public property subjectReference : TReference read GetsubjectReference write SetsubjectReference;
Public property subjectCanonical : string read GetsubjectCanonical write SetsubjectCanonical;
Public property subjectCanonicalElement : Tcanonical read GetsubjectCanonicalElement write SetsubjectCanonicalElement;
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 usage : string read Getusage write Setusage;
Public property usageElement : Tmarkdown read GetusageElement write SetusageElement;
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 library_ : TBSFHIRPrimitiveStringArray read Getlibrary_Array;
Public property goal : TPlanDefinitionGoalArray read GetgoalArray;
Public property actor : TPlanDefinitionActorArray read GetactorArray;
Public property action : TPlanDefinitionActionArray read GetactionArray;
Public property asNeededBoolean : boolean read GetasNeededBoolean write SetasNeededBoolean;
Public property asNeededBooleanElement : Tboolean read GetasNeededBooleanElement write SetasNeededBooleanElement;
Public property asNeededCodeableConcept : TCodeableConcept read GetasNeededCodeableConcept write SetasNeededCodeableConcept;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

An absolute URI that is used to identify this plan 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 plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan 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 plan definition 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 plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

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 plan 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 plan definition.

Public property titleElement : Tstring read GettitleElement write SettitleElement;
 
Public property subtitle : string read Getsubtitle write Setsubtitle;

An explanatory or alternate title for the plan definition giving additional information about its content.

Public property subtitleElement : Tstring read GetsubtitleElement write SetsubtitleElement;
 
Public property type_ : TCodeableConcept read Gettype_ write Settype_;

A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

Public property status : string read Getstatus write Setstatus;

The status of this plan definition. 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 plan definition 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 subjectCodeableConcept : TCodeableConcept read GetsubjectCodeableConcept write SetsubjectCodeableConcept;

A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. (choose any one of subject*, but only one)

Public property subjectReference : TReference read GetsubjectReference write SetsubjectReference;

A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. (choose any one of subject*, but only one)

Public property subjectCanonical : string read GetsubjectCanonical write SetsubjectCanonical;

A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. (choose any one of subject*, but only one)

Public property subjectCanonicalElement : Tcanonical read GetsubjectCanonicalElement write SetsubjectCanonicalElement;
 
Public property date_ : string read Getdate_ write Setdate_;

The date (and optionally time) when the plan 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 plan 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 plan 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 plan 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 plan definition instances.

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

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

Public property purpose : string read Getpurpose write Setpurpose;

Explanation of why this plan definition is needed and why it has been designed as it has.

Public property purposeElement : Tmarkdown read GetpurposeElement write SetpurposeElement;
 
Public property usage : string read Getusage write Setusage;

A detailed description of how the plan definition is used from a clinical perspective.

Public property usageElement : Tmarkdown read GetusageElement write SetusageElement;
 
Public property copyright : string read Getcopyright write Setcopyright;

A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan 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 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 plan definition content was or is planned to be in active use.

Public property topic : TCodeableConceptArray read GettopicArray;

Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition 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 content.

Public property editor : TContactDetailArray read GeteditorArray;

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

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

Public property endorser : TContactDetailArray read GetendorserArray;

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

Public property relatedArtifact : TRelatedArtifactArray read GetrelatedArtifactArray;

Related artifacts such as additional documentation, justification, or bibliographic references.

Public property library_ : TBSFHIRPrimitiveStringArray read Getlibrary_Array;

A reference to a Library resource containing any formal logic used by the plan definition.

Public property goal : TPlanDefinitionGoalArray read GetgoalArray;

A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.

Public property actor : TPlanDefinitionActorArray read GetactorArray;

Actors represent the individuals or groups involved in the execution of the defined set of activities.

Public property action : TPlanDefinitionActionArray read GetactionArray;

An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

Public property asNeededBoolean : boolean read GetasNeededBoolean write SetasNeededBoolean;

If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. (choose any one of asNeeded*, but only one)

Public property asNeededBooleanElement : Tboolean read GetasNeededBooleanElement write SetasNeededBooleanElement;
 
Public property asNeededCodeableConcept : TCodeableConcept read GetasNeededCodeableConcept write SetasNeededCodeableConcept;

If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. (choose any one of asNeeded*, but only one)

Generated by PasDoc 0.15.0.