Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TAppointment

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TAppointment = class(TDomainResource)

Description

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). 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 identifier : TIdentifierArray read GetidentifierArray;
Public property status : string read Getstatus write Setstatus;
Public property statusElement : TAppointmentStatus read GetstatusElement write SetstatusElement;
Public property cancellationReason : TCodeableConcept read GetcancellationReason write SetcancellationReason;
Public property class_ : TCodeableConceptArray read Getclass_Array;
Public property serviceCategory : TCodeableConceptArray read GetserviceCategoryArray;
Public property serviceType : TCodeableReferenceArray read GetserviceTypeArray;
Public property specialty : TCodeableConceptArray read GetspecialtyArray;
Public property appointmentType : TCodeableConcept read GetappointmentType write SetappointmentType;
Public property reason : TCodeableReferenceArray read GetreasonArray;
Public property priority : TCodeableConcept read Getpriority write Setpriority;
Public property description : string read Getdescription write Setdescription;
Public property descriptionElement : Tstring read GetdescriptionElement write SetdescriptionElement;
Public property replaces : TReferenceArray read GetreplacesArray;
Public property virtualService : TVirtualServiceDetailArray read GetvirtualServiceArray;
Public property supportingInformation : TReferenceArray read GetsupportingInformationArray;
Public property previousAppointment : TReference read GetpreviousAppointment write SetpreviousAppointment;
Public property originatingAppointment : TReference read GetoriginatingAppointment write SetoriginatingAppointment;
Public property start : string read Getstart write Setstart;
Public property startElement : Tinstant read GetstartElement write SetstartElement;
Public property end_ : string read Getend_ write Setend_;
Public property end_Element : Tinstant read Getend_Element write Setend_Element;
Public property minutesDuration : Int64 read GetminutesDuration write SetminutesDuration;
Public property minutesDurationElement : TpositiveInt read GetminutesDurationElement write SetminutesDurationElement;
Public property requestedPeriod : TPeriodArray read GetrequestedPeriodArray;
Public property slot : TReferenceArray read GetslotArray;
Public property account : TReferenceArray read GetaccountArray;
Public property created : string read Getcreated write Setcreated;
Public property createdElement : TdateTime_ read GetcreatedElement write SetcreatedElement;
Public property cancellationDate : string read GetcancellationDate write SetcancellationDate;
Public property cancellationDateElement : TdateTime_ read GetcancellationDateElement write SetcancellationDateElement;
Public property note : TAnnotationArray read GetnoteArray;
Public property patientInstruction : TCodeableReferenceArray read GetpatientInstructionArray;
Public property basedOn : TReferenceArray read GetbasedOnArray;
Public property subject : TReference read Getsubject write Setsubject;
Public property participant : TAppointmentParticipantArray read GetparticipantArray;
Public property recurrenceId : Int64 read GetrecurrenceId write SetrecurrenceId;
Public property recurrenceIdElement : TpositiveInt read GetrecurrenceIdElement write SetrecurrenceIdElement;
Public property occurrenceChanged : boolean read GetoccurrenceChanged write SetoccurrenceChanged;
Public property occurrenceChangedElement : Tboolean read GetoccurrenceChangedElement write SetoccurrenceChangedElement;
Public property recurrenceTemplate : TAppointmentRecurrenceTemplateArray read GetrecurrenceTemplateArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property identifier : TIdentifierArray read GetidentifierArray;

This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Public property status : string read Getstatus write Setstatus;

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

Public property statusElement : TAppointmentStatus read GetstatusElement write SetstatusElement;
 
Public property cancellationReason : TCodeableConcept read GetcancellationReason write SetcancellationReason;

The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

Public property class_ : TCodeableConceptArray read Getclass_Array;

Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

Public property serviceCategory : TCodeableConceptArray read GetserviceCategoryArray;

A broad categorization of the service that is to be performed during this appointment.

Public property serviceType : TCodeableReferenceArray read GetserviceTypeArray;

The specific service that is to be performed during this appointment.

Public property specialty : TCodeableConceptArray read GetspecialtyArray;

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Public property appointmentType : TCodeableConcept read GetappointmentType write SetappointmentType;

The style of appointment or patient that has been booked in the slot (not service type).

Public property reason : TCodeableReferenceArray read GetreasonArray;

The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

Public property priority : TCodeableConcept read Getpriority write Setpriority;

The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

Public property description : string read Getdescription write Setdescription;

The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the note field.

Public property descriptionElement : Tstring read GetdescriptionElement write SetdescriptionElement;
 
Public property replaces : TReferenceArray read GetreplacesArray;

Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).

Public property virtualService : TVirtualServiceDetailArray read GetvirtualServiceArray;

Connection details of a virtual service (e.g. conference call).

Public property supportingInformation : TReferenceArray read GetsupportingInformationArray;

Additional information to support the appointment provided when making the appointment.

Public property previousAppointment : TReference read GetpreviousAppointment write SetpreviousAppointment;

The previous appointment in a series of related appointments.

Public property originatingAppointment : TReference read GetoriginatingAppointment write SetoriginatingAppointment;

The originating appointment in a recurring set of related appointments.

Public property start : string read Getstart write Setstart;

Date/Time that the appointment is to take place.

Public property startElement : Tinstant read GetstartElement write SetstartElement;
 
Public property end_ : string read Getend_ write Setend_;

Date/Time that the appointment is to conclude.

Public property end_Element : Tinstant read Getend_Element write Setend_Element;
 
Public property minutesDuration : Int64 read GetminutesDuration write SetminutesDuration;

Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

Public property minutesDurationElement : TpositiveInt read GetminutesDurationElement write SetminutesDurationElement;
 
Public property requestedPeriod : TPeriodArray read GetrequestedPeriodArray;

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

Public property slot : TReferenceArray read GetslotArray;

The slots from the participants' schedules that will be filled by the appointment.

Public property account : TReferenceArray read GetaccountArray;

The set of accounts that is expected to be used for billing the activities that result from this Appointment.

Public property created : string read Getcreated write Setcreated;

The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

Public property createdElement : TdateTime_ read GetcreatedElement write SetcreatedElement;
 
Public property cancellationDate : string read GetcancellationDate write SetcancellationDate;

The date/time describing when the appointment was cancelled.

Public property cancellationDateElement : TdateTime_ read GetcancellationDateElement write SetcancellationDateElement;
 
Public property note : TAnnotationArray read GetnoteArray;

Additional notes/comments about the appointment.

Public property patientInstruction : TCodeableReferenceArray read GetpatientInstructionArray;

While Appointment.note contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).

Public property basedOn : TReferenceArray read GetbasedOnArray;

The request this appointment is allocated to assess (e.g. incoming referral or procedure request).

Public property subject : TReference read Getsubject write Setsubject;

The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.

Public property participant : TAppointmentParticipantArray read GetparticipantArray;

List of participants involved in the appointment.

Public property recurrenceId : Int64 read GetrecurrenceId write SetrecurrenceId;

The sequence number that identifies a specific appointment in a recurring pattern.

Public property recurrenceIdElement : TpositiveInt read GetrecurrenceIdElement write SetrecurrenceIdElement;
 
Public property occurrenceChanged : boolean read GetoccurrenceChanged write SetoccurrenceChanged;

This appointment varies from the recurring pattern.

Public property occurrenceChangedElement : Tboolean read GetoccurrenceChangedElement write SetoccurrenceChangedElement;
 
Public property recurrenceTemplate : TAppointmentRecurrenceTemplateArray read GetrecurrenceTemplateArray;

The details of the recurrence pattern or template that is used to generate recurring appointments.

Generated by PasDoc 0.15.0.