Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TMessageDefinition

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r4

Declaration

type TMessageDefinition = class(TDomainResource)

Description

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted. 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 replaces : TBSFHIRPrimitiveStringArray read GetreplacesArray;
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 base : string read Getbase write Setbase;
Public property baseElement : Tcanonical read GetbaseElement write SetbaseElement;
Public property parent : TBSFHIRPrimitiveStringArray read GetparentArray;
Public property event : TElement read Getevent write Setevent;
Public property category : string read Getcategory write Setcategory;
Public property categoryElement : TMessageSignificanceCategory read GetcategoryElement write SetcategoryElement;
Public property focus : TMessageDefinitionFocusArray read GetfocusArray;
Public property responseRequired : string read GetresponseRequired write SetresponseRequired;
Public property responseRequiredElement : TmessageheaderResponseRequest read GetresponseRequiredElement write SetresponseRequiredElement;
Public property allowedResponse : TMessageDefinitionAllowedResponseArray read GetallowedResponseArray;
Public property graph : TBSFHIRPrimitiveStringArray read GetgraphArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property url : string read Geturl write Seturl;

The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.

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

A formal identifier that is used to identify this message 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 message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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 message 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 message definition.

Public property titleElement : Tstring read GettitleElement write SettitleElement;
 
Public property replaces : TBSFHIRPrimitiveStringArray read GetreplacesArray;

A MessageDefinition that is superseded by this definition.

Public property status : string read Getstatus write Setstatus;

The status of this message 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 message 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 message 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 message 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 message 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 message 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 message definition instances.

Public property jurisdiction : TCodeableConceptArray read GetjurisdictionArray;

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

Public property purpose : string read Getpurpose write Setpurpose;

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

Public property copyrightElement : Tmarkdown read GetcopyrightElement write SetcopyrightElement;
 
Public property base : string read Getbase write Setbase;

The MessageDefinition that is the basis for the contents of this resource.

Public property baseElement : Tcanonical read GetbaseElement write SetbaseElement;
 
Public property parent : TBSFHIRPrimitiveStringArray read GetparentArray;

Identifies a protocol or workflow that this MessageDefinition represents a step in.

Public property event : TElement read Getevent write Setevent;

Event code or link to the EventDefinition.

Public property category : string read Getcategory write Setcategory;

The impact of the content of the message.

Public property categoryElement : TMessageSignificanceCategory read GetcategoryElement write SetcategoryElement;
 
Public property focus : TMessageDefinitionFocusArray read GetfocusArray;

Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.

Public property responseRequired : string read GetresponseRequired write SetresponseRequired;

Declare at a message definition level whether a response is required or only upon error or success, or never.

Public property responseRequiredElement : TmessageheaderResponseRequest read GetresponseRequiredElement write SetresponseRequiredElement;
 
Public property allowedResponse : TMessageDefinitionAllowedResponseArray read GetallowedResponseArray;

Indicates what types of messages may be sent as an application-level response to this message.

Public property graph : TBSFHIRPrimitiveStringArray read GetgraphArray;

Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [[[GraphDefinition]]] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.

Generated by PasDoc 0.15.0.