Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TStructureDefinition

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r4

Declaration

type TStructureDefinition = class(TDomainResource)

Description

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types. 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 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 keyword : TCodingArray read GetkeywordArray;
Public property fhirVersion : string read GetfhirVersion write SetfhirVersion;
Public property fhirVersionElement : TFHIRVersion read GetfhirVersionElement write SetfhirVersionElement;
Public property mapping : TStructureDefinitionMappingArray read GetmappingArray;
Public property kind : string read Getkind write Setkind;
Public property kindElement : TStructureDefinitionKind read GetkindElement write SetkindElement;
Public property abstract_ : boolean read Getabstract_ write Setabstract_;
Public property abstract_Element : Tboolean read Getabstract_Element write Setabstract_Element;
Public property context : TStructureDefinitionContextArray read GetcontextArray;
Public property contextInvariant : TBSFHIRPrimitiveStringArray read GetcontextInvariantArray;
Public property type_ : string read Gettype_ write Settype_;
Public property type_Element : Turi read Gettype_Element write Settype_Element;
Public property baseDefinition : string read GetbaseDefinition write SetbaseDefinition;
Public property baseDefinitionElement : Tcanonical read GetbaseDefinitionElement write SetbaseDefinitionElement;
Public property derivation : string read Getderivation write Setderivation;
Public property derivationElement : TTypeDerivationRule read GetderivationElement write SetderivationElement;
Public property snapshot : TStructureDefinitionSnapshot read Getsnapshot write Setsnapshot;
Public property differential : TStructureDefinitionDifferential read Getdifferential write Setdifferential;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

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

Public property versionElement : Tstring read GetversionElement write SetversionElement;
 
Public property name_ : string read Getname_ write Setname_;

A natural language name identifying the structure 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 structure definition.

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

The status of this structure 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 structure 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 date_ : string read Getdate_ write Setdate_;

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

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

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

Public property purpose : string read Getpurpose write Setpurpose;

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

Public property copyrightElement : Tmarkdown read GetcopyrightElement write SetcopyrightElement;
 
Public property keyword : TCodingArray read GetkeywordArray;

A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.

Public property fhirVersion : string read GetfhirVersion write SetfhirVersion;

The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.

Public property fhirVersionElement : TFHIRVersion read GetfhirVersionElement write SetfhirVersionElement;
 
Public property mapping : TStructureDefinitionMappingArray read GetmappingArray;

An external specification that the content is mapped to.

Public property kind : string read Getkind write Setkind;

Defines the kind of structure that this definition is describing.

Public property kindElement : TStructureDefinitionKind read GetkindElement write SetkindElement;
 
Public property abstract_ : boolean read Getabstract_ write Setabstract_;

Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.

Public property abstract_Element : Tboolean read Getabstract_Element write Setabstract_Element;
 
Public property context : TStructureDefinitionContextArray read GetcontextArray;

Identifies the types of resource or data type elements to which the extension can be applied.

Public property contextInvariant : TBSFHIRPrimitiveStringArray read GetcontextInvariantArray;

A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.

Public property type_ : string read Gettype_ write Settype_;

The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.

Public property type_Element : Turi read Gettype_Element write Settype_Element;
 
Public property baseDefinition : string read GetbaseDefinition write SetbaseDefinition;

An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.

Public property baseDefinitionElement : Tcanonical read GetbaseDefinitionElement write SetbaseDefinitionElement;
 
Public property derivation : string read Getderivation write Setderivation;

How the type relates to the baseDefinition.

Public property derivationElement : TTypeDerivationRule read GetderivationElement write SetderivationElement;
 
Public property snapshot : TStructureDefinitionSnapshot read Getsnapshot write Setsnapshot;

A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.

Public property differential : TStructureDefinitionDifferential read Getdifferential write Setdifferential;

A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.

Generated by PasDoc 0.15.0.