Skip to main content

HS.FHIRModel.R4.Appointment

class HS.FHIRModel.R4.Appointment extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Appointment generated class schema
*****************************************
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).

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_APPOINTMENT;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _comment as HS.FHIRModel.R4.Element;
Extensions for comment
Property methods: _commentGet(), _commentGetSwizzled(), _commentIsValid(), _commentNewObject(), _commentSet()
property _created as HS.FHIRModel.R4.Element;
Extensions for created
Property methods: _createdGet(), _createdGetSwizzled(), _createdIsValid(), _createdNewObject(), _createdSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _end as HS.FHIRModel.R4.Element;
Extensions for end
Property methods: _endGet(), _endGetSwizzled(), _endIsValid(), _endNewObject(), _endSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _minutesDuration as HS.FHIRModel.R4.Element;
Extensions for minutesDuration
Property methods: _minutesDurationGet(), _minutesDurationGetSwizzled(), _minutesDurationIsValid(), _minutesDurationNewObject(), _minutesDurationSet()
property _patientInstruction as HS.FHIRModel.R4.Element;
Extensions for patientInstruction
Property methods: _patientInstructionGet(), _patientInstructionGetSwizzled(), _patientInstructionIsValid(), _patientInstructionNewObject(), _patientInstructionSet()
property _priority as HS.FHIRModel.R4.Element;
Extensions for priority
Property methods: _priorityGet(), _priorityGetSwizzled(), _priorityIsValid(), _priorityNewObject(), _prioritySet()
property _start as HS.FHIRModel.R4.Element;
Extensions for start
Property methods: _startGet(), _startGetSwizzled(), _startIsValid(), _startNewObject(), _startSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property appointmentType as HS.FHIRModel.R4.CodeableConcept;
The style of appointment or patient that has been booked in the slot (not service type).
Property methods: appointmentTypeGet(), appointmentTypeGetSwizzled(), appointmentTypeIsValid(), appointmentTypeNewObject(), appointmentTypeSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property cancelationReason as HS.FHIRModel.R4.CodeableConcept;
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.
Property methods: cancelationReasonGet(), cancelationReasonGetSwizzled(), cancelationReasonIsValid(), cancelationReasonNewObject(), cancelationReasonSet()
property comment as %String;
Additional comments about the appointment.
Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property created as %String;
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.
Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property description as %String;
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.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property end as %String;
Date/Time that the appointment is to conclude.
Property methods: endDisplayToLogical(), endGet(), endIsValid(), endLogicalToDisplay(), endLogicalToOdbc(), endNormalize(), endSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
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).
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property minutesDuration as %Integer;
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.
Property methods: minutesDurationDisplayToLogical(), minutesDurationGet(), minutesDurationIsValid(), minutesDurationLogicalToDisplay(), minutesDurationNormalize(), minutesDurationSet(), minutesDurationXSDToLogical()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property participant as HS.FHIRModel.R4.AppointmentX.SeqOfAppointmentXParticipant [ Required ];
List of participants involved in the appointment.
Property methods: participantGet(), participantGetSwizzled(), participantIsValid(), participantNewObject(), participantSet()
property patientInstruction as %String;
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).
Property methods: patientInstructionDisplayToLogical(), patientInstructionGet(), patientInstructionIsValid(), patientInstructionLogicalToDisplay(), patientInstructionLogicalToOdbc(), patientInstructionNormalize(), patientInstructionSet()
property priority as %Integer;
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).
Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityNormalize(), prioritySet(), priorityXSDToLogical()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
The coded reason that this appointment is being scheduled. This is more clinical than administrative.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
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.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property requestedPeriod as HS.FHIRModel.R4.SeqOfPeriod;
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.
Property methods: requestedPeriodGet(), requestedPeriodGetSwizzled(), requestedPeriodIsValid(), requestedPeriodNewObject(), requestedPeriodSet()
property resourceType as %String [ InitialExpression = "Appointment" , Required ];
This is a Appointment resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property serviceCategory as HS.FHIRModel.R4.SeqOfCodeableConcept;
A broad categorization of the service that is to be performed during this appointment.
Property methods: serviceCategoryGet(), serviceCategoryGetSwizzled(), serviceCategoryIsValid(), serviceCategoryNewObject(), serviceCategorySet()
property serviceType as HS.FHIRModel.R4.SeqOfCodeableConcept;
The specific service that is to be performed during this appointment.
Property methods: serviceTypeGet(), serviceTypeGetSwizzled(), serviceTypeIsValid(), serviceTypeNewObject(), serviceTypeSet()
property slot as HS.FHIRModel.R4.SeqOfReference;
The slots from the participants' schedules that will be filled by the appointment.
Property methods: slotGet(), slotGetSwizzled(), slotIsValid(), slotNewObject(), slotSet()
property specialty as HS.FHIRModel.R4.SeqOfCodeableConcept;
The specialty of a practitioner that would be required to perform the service requested in this appointment.
Property methods: specialtyGet(), specialtyGetSwizzled(), specialtyIsValid(), specialtyNewObject(), specialtySet()
property start as %String;
Date/Time that the appointment is to take place.
Property methods: startDisplayToLogical(), startGet(), startIsValid(), startLogicalToDisplay(), startLogicalToOdbc(), startNormalize(), startSet()
property status as %String (VALUELIST = ",proposed,pending,booked,arrived,fulfilled,cancelled,noshow,entered-in-error,checked-in,waitlist");
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.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property supportingInformation as HS.FHIRModel.R4.SeqOfReference;
Additional information to support the appointment provided when making the appointment.
Property methods: supportingInformationGet(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationNewObject(), supportingInformationSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeAppointmentType()
method IncludeBasedOn()
method IncludeCancelationReason()
method IncludeContained()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeParticipant()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeRequestedPeriod()
method IncludeServiceCategory()
method IncludeServiceType()
method IncludeSlot()
method IncludeSpecialty()
method IncludeSupportingInformation()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab