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_r4

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 cancelationReason : TCodeableConcept read GetcancelationReason write SetcancelationReason;
Public property serviceCategory : TCodeableConceptArray read GetserviceCategoryArray;
Public property serviceType : TCodeableConceptArray read GetserviceTypeArray;
Public property specialty : TCodeableConceptArray read GetspecialtyArray;
Public property appointmentType : TCodeableConcept read GetappointmentType write SetappointmentType;
Public property reasonCode : TCodeableConceptArray read GetreasonCodeArray;
Public property reasonReference : TReferenceArray read GetreasonReferenceArray;
Public property priority : Int64 read Getpriority write Setpriority;
Public property priorityElement : TunsignedInt read GetpriorityElement write SetpriorityElement;
Public property description : string read Getdescription write Setdescription;
Public property descriptionElement : Tstring read GetdescriptionElement write SetdescriptionElement;
Public property supportingInformation : TReferenceArray read GetsupportingInformationArray;
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 slot : TReferenceArray read GetslotArray;
Public property created : string read Getcreated write Setcreated;
Public property createdElement : TdateTime_ read GetcreatedElement write SetcreatedElement;
Public property comment : string read Getcomment write Setcomment;
Public property commentElement : Tstring read GetcommentElement write SetcommentElement;
Public property patientInstruction : string read GetpatientInstruction write SetpatientInstruction;
Public property patientInstructionElement : Tstring read GetpatientInstructionElement write SetpatientInstructionElement;
Public property basedOn : TReferenceArray read GetbasedOnArray;
Public property participant : TAppointmentParticipantArray read GetparticipantArray;
Public property requestedPeriod : TPeriodArray read GetrequestedPeriodArray;

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 cancelationReason : TCodeableConcept read GetcancelationReason write SetcancelationReason;

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 serviceCategory : TCodeableConceptArray read GetserviceCategoryArray;

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

Public property serviceType : TCodeableConceptArray 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 reasonCode : TCodeableConceptArray read GetreasonCodeArray;

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

Public property reasonReference : TReferenceArray read GetreasonReferenceArray;

Reason the appointment has been scheduled to take place, 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 : Int64 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 priorityElement : TunsignedInt read GetpriorityElement write SetpriorityElement;
 
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 comment field.

Public property descriptionElement : Tstring read GetdescriptionElement write SetdescriptionElement;
 
Public property supportingInformation : TReferenceArray read GetsupportingInformationArray;

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

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 slot : TReferenceArray read GetslotArray;

The slots from the participants' schedules that will be filled by the 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 comment : string read Getcomment write Setcomment;

Additional comments about the appointment.

Public property commentElement : Tstring read GetcommentElement write SetcommentElement;
 
Public property patientInstruction : string read GetpatientInstruction write SetpatientInstruction;

While Appointment.comment 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 patientInstructionElement : Tstring read GetpatientInstructionElement write SetpatientInstructionElement;
 
Public property basedOn : TReferenceArray read GetbasedOnArray;

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

Public property participant : TAppointmentParticipantArray read GetparticipantArray;

List of participants involved in the appointment.

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.

Generated by PasDoc 0.15.0.