Skip to main content

HS.FHIR.vSTU3.Model.Resource.Appointment

deprecated class HS.FHIR.vSTU3.Model.Resource.Appointment extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = Appointment;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property appointmentType as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "appointmentType", XMLPROJECTION = "ELEMENT");
The style of appointment or patient that has been booked in the slot (not service type).
Property methods: appointmentTypeGet(), appointmentTypeGetSwizzled(), appointmentTypeIsValid(), appointmentTypeNewObject(), appointmentTypeSet()
property comment as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "comment", XMLPROJECTION = "ELEMENT");
Additional comments about the appointment.
Property methods: commentGet(), commentGetSwizzled(), commentIsValid(), commentNewObject(), commentSet()
property created as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "created", XMLPROJECTION = "ELEMENT");
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: createdGet(), createdGetSwizzled(), createdIsValid(), createdNewObject(), createdSet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
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: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property end as HS.FHIR.vSTU3.Model.Datatype.Instant (XMLNAME = "end", XMLPROJECTION = "ELEMENT");
Date/Time that the appointment is to conclude.
Property methods: endGet(), endGetSwizzled(), endIsValid(), endNewObject(), endSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
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: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property incomingReferral as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "incomingReferral", XMLPROJECTION = "ELEMENT");
The referral request this appointment is allocated to assess (incoming referral).
Property methods: incomingReferralBuildValueArray(), incomingReferralCollectionToDisplay(), incomingReferralCollectionToOdbc(), incomingReferralDisplayToCollection(), incomingReferralGet(), incomingReferralGetObject(), incomingReferralGetObjectId(), incomingReferralGetSwizzled(), incomingReferralIsValid(), incomingReferralOdbcToCollection(), incomingReferralSet(), incomingReferralSetObject(), incomingReferralSetObjectId()
property indication as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "indication", XMLPROJECTION = "ELEMENT");
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: indicationBuildValueArray(), indicationCollectionToDisplay(), indicationCollectionToOdbc(), indicationDisplayToCollection(), indicationGet(), indicationGetObject(), indicationGetObjectId(), indicationGetSwizzled(), indicationIsValid(), indicationOdbcToCollection(), indicationSet(), indicationSetObject(), indicationSetObjectId()
property minutesDuration as HS.FHIR.vSTU3.Model.Datatype.PositiveInt (XMLNAME = "minutesDuration", XMLPROJECTION = "ELEMENT");
Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
Property methods: minutesDurationGet(), minutesDurationGetSwizzled(), minutesDurationIsValid(), minutesDurationNewObject(), minutesDurationSet()
property participant as list of HS.FHIR.vSTU3.Model.Resource.Appointment.Participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT");
List of participants involved in the appointment.
Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property priority as HS.FHIR.vSTU3.Model.Datatype.UnsignedInt (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
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: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property reason as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
The reason that this appointment is being scheduled. This is more clinical than administrative.
Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property requestedPeriod as list of HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "requestedPeriod", XMLPROJECTION = "ELEMENT");
A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.
Property methods: requestedPeriodBuildValueArray(), requestedPeriodCollectionToDisplay(), requestedPeriodCollectionToOdbc(), requestedPeriodDisplayToCollection(), requestedPeriodGet(), requestedPeriodGetObject(), requestedPeriodGetObjectId(), requestedPeriodGetSwizzled(), requestedPeriodIsValid(), requestedPeriodOdbcToCollection(), requestedPeriodSet(), requestedPeriodSetObject(), requestedPeriodSetObjectId()
property serviceCategory as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "serviceCategory", XMLPROJECTION = "ELEMENT");
A broad categorisation of the service that is to be performed during this appointment.
Property methods: serviceCategoryGet(), serviceCategoryGetSwizzled(), serviceCategoryIsValid(), serviceCategoryNewObject(), serviceCategorySet()
property serviceType as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "serviceType", XMLPROJECTION = "ELEMENT");
The specific service that is to be performed during this appointment.
Property methods: serviceTypeBuildValueArray(), serviceTypeCollectionToDisplay(), serviceTypeCollectionToOdbc(), serviceTypeDisplayToCollection(), serviceTypeGet(), serviceTypeGetObject(), serviceTypeGetObjectId(), serviceTypeGetSwizzled(), serviceTypeIsValid(), serviceTypeOdbcToCollection(), serviceTypeSet(), serviceTypeSetObject(), serviceTypeSetObjectId()
property slot as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "slot", XMLPROJECTION = "ELEMENT");
The slots from the participants' schedules that will be filled by the appointment.
Property methods: slotBuildValueArray(), slotCollectionToDisplay(), slotCollectionToOdbc(), slotDisplayToCollection(), slotGet(), slotGetObject(), slotGetObjectId(), slotGetSwizzled(), slotIsValid(), slotOdbcToCollection(), slotSet(), slotSetObject(), slotSetObjectId()
property specialty as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "specialty", XMLPROJECTION = "ELEMENT");
The specialty of a practitioner that would be required to perform the service requested in this appointment.
Property methods: specialtyBuildValueArray(), specialtyCollectionToDisplay(), specialtyCollectionToOdbc(), specialtyDisplayToCollection(), specialtyGet(), specialtyGetObject(), specialtyGetObjectId(), specialtyGetSwizzled(), specialtyIsValid(), specialtyOdbcToCollection(), specialtySet(), specialtySetObject(), specialtySetObjectId()
property start as HS.FHIR.vSTU3.Model.Datatype.Instant (XMLNAME = "start", XMLPROJECTION = "ELEMENT");
Date/Time that the appointment is to take place.
Property methods: startGet(), startGetSwizzled(), startIsValid(), startNewObject(), startSet()
property status as HS.FHIR.vSTU3.Model.Base.AppointmentStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
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: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property supportingInformation as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");
Additional information to support the appointment provided when making the appointment.
Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()

Methods

deprecated method SetAppointmentType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "appointmentType" property.
deprecated method SetComment(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "comment" property.
deprecated method SetCreated(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "created" property.
deprecated method SetDescription(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
deprecated method SetEnd(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "end" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetIncomingReferral(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "incomingReferral" property.
deprecated method SetIndication(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "indication" property.
deprecated method SetMinutesDuration(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "minutesDuration" property.
deprecated method SetPriority(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "priority" property.
deprecated method SetReason(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reason" property.
deprecated method SetRequestedPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "requestedPeriod" property.
deprecated method SetServiceCategory(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "serviceCategory" property.
deprecated method SetServiceType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "serviceType" property.
deprecated method SetSlot(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "slot" property.
deprecated method SetSpecialty(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "specialty" property.
deprecated method SetStart(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "start" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSupportingInformation(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "supportingInformation" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab