Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TCapabilityStatement

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r4

Declaration

type TCapabilityStatement = class(TDomainResource)

Description

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation. 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 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 kind : string read Getkind write Setkind;
Public property kindElement : TCapabilityStatementKind read GetkindElement write SetkindElement;
Public property instantiates : TBSFHIRPrimitiveStringArray read GetinstantiatesArray;
Public property imports : TBSFHIRPrimitiveStringArray read GetimportsArray;
Public property software : TCapabilityStatementSoftware read Getsoftware write Setsoftware;
Public property implementation_ : TCapabilityStatementImplementation read Getimplementation_ write Setimplementation_;
Public property fhirVersion : string read GetfhirVersion write SetfhirVersion;
Public property fhirVersionElement : TFHIRVersion read GetfhirVersionElement write SetfhirVersionElement;
Public property format : TBSFHIRPrimitiveStringArray read GetformatArray;
Public property patchFormat : TBSFHIRPrimitiveStringArray read GetpatchFormatArray;
Public property implementationGuide : TBSFHIRPrimitiveStringArray read GetimplementationGuideArray;
Public property rest : TCapabilityStatementRestArray read GetrestArray;
Public property messaging : TCapabilityStatementMessagingArray read GetmessagingArray;
Public property document : TCapabilityStatementDocumentArray read GetdocumentArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

An absolute URI that is used to identify this capability statement 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 capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.

Public property urlElement : Turi read GeturlElement write SeturlElement;
 
Public property version : string read Getversion write Setversion;

The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement 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 capability statement. 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 capability statement.

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

The status of this capability statement. 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 capability statement 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 capability statement 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 capability statement 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 capability statement.

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 capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.

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 capability statement instances.

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

A legal or geographic region in which the capability statement is intended to be used.

Public property purpose : string read Getpurpose write Setpurpose;

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

Public property copyrightElement : Tmarkdown read GetcopyrightElement write SetcopyrightElement;
 
Public property kind : string read Getkind write Setkind;

The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).

Public property kindElement : TCapabilityStatementKind read GetkindElement write SetkindElement;
 
Public property instantiates : TBSFHIRPrimitiveStringArray read GetinstantiatesArray;

Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.

Public property imports : TBSFHIRPrimitiveStringArray read GetimportsArray;

Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.

Public property software : TCapabilityStatementSoftware read Getsoftware write Setsoftware;

Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.

Public property implementation_ : TCapabilityStatementImplementation read Getimplementation_ write Setimplementation_;

Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.

Public property fhirVersion : string read GetfhirVersion write SetfhirVersion;

The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.

Public property fhirVersionElement : TFHIRVersion read GetfhirVersionElement write SetfhirVersionElement;
 
Public property format : TBSFHIRPrimitiveStringArray read GetformatArray;

A list of the formats supported by this implementation using their content types.

Public property patchFormat : TBSFHIRPrimitiveStringArray read GetpatchFormatArray;

A list of the patch formats supported by this implementation using their content types.

Public property implementationGuide : TBSFHIRPrimitiveStringArray read GetimplementationGuideArray;

A list of implementation guides that the server does (or should) support in their entirety.

Public property rest : TCapabilityStatementRestArray read GetrestArray;

A definition of the restful capabilities of the solution, if any.

Public property messaging : TCapabilityStatementMessagingArray read GetmessagingArray;

A description of the messaging capabilities of the solution.

Public property document : TCapabilityStatementDocumentArray read GetdocumentArray;

A document definition.

Generated by PasDoc 0.15.0.