Skip to main content

HS.FHIR.vSTU3.Model.Resource.Slot

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A slot of time on a schedule that may be available for booking appointments.
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 = Slot;
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 may be 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");
Comments on the slot to describe any extended information. Such as custom constraints on the slot.
Property methods: commentGet(), commentGetSwizzled(), commentIsValid(), commentNewObject(), commentSet()
property end as HS.FHIR.vSTU3.Model.Datatype.Instant (XMLNAME = "end", XMLPROJECTION = "ELEMENT") [ Required ];
Date/Time that the slot 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");
External Ids for this item.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property overbooked as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "overbooked", XMLPROJECTION = "ELEMENT");
This slot has already been overbooked, appointments are unlikely to be accepted for this time.
Property methods: overbookedGet(), overbookedGetSwizzled(), overbookedIsValid(), overbookedNewObject(), overbookedSet()
property schedule as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "schedule", XMLPROJECTION = "ELEMENT") [ Required ];
The schedule resource that this slot defines an interval of status information.
Property methods: scheduleGet(), scheduleGetSwizzled(), scheduleIsValid(), scheduleNewObject(), scheduleSet()
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 type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
Property methods: serviceTypeBuildValueArray(), serviceTypeCollectionToDisplay(), serviceTypeCollectionToOdbc(), serviceTypeDisplayToCollection(), serviceTypeGet(), serviceTypeGetObject(), serviceTypeGetObjectId(), serviceTypeGetSwizzled(), serviceTypeIsValid(), serviceTypeOdbcToCollection(), serviceTypeSet(), serviceTypeSetObject(), serviceTypeSetObjectId()
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") [ Required ];
Date/Time that the slot is to begin.
Property methods: startGet(), startGetSwizzled(), startIsValid(), startNewObject(), startSet()
property status as HS.FHIR.vSTU3.Model.Base.SlotStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
busy | free | busy-unavailable | busy-tentative | entered-in-error.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()

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 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 SetOverbooked(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 "overbooked" property.
deprecated method SetSchedule(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "schedule" 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 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.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab