Skip to main content


class HS.FHIR.DTL.vDSTU2.Model.Resource.Slot extends HS.FHIR.DTL.vDSTU2.Model.Base.DomainResource

A slot of time on a schedule that may be available for booking appointments.

Property Inventory


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.
parameter XMLTYPE = Slot;
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.


property comment as %String (MAXLEN = 1000000, XMLNAME = "comment", XMLPROJECTION = "ATTRIBUTE");

Comments on the slot to describe any extended information. Such as custom constraints on the slot.

Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
property end as %String (MAXLEN = 1000000, XMLNAME = "end", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Date/Time that the slot is to conclude.

Property methods: endDisplayToLogical(), endGet(), endIsValid(), endLogicalToDisplay(), endLogicalToOdbc(), endNormalize(), endSet()
property freeBusyType as %String (MAXLEN = 1000000, XMLNAME = "freeBusyType", XMLPROJECTION = "ATTRIBUTE") [ Required ];

busy | free | busy-unavailable | busy-tentative

slotstatus is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend slotstatus and you may NOT use codes from other ValueSets.

Property methods: freeBusyTypeDisplayToLogical(), freeBusyTypeGet(), freeBusyTypeIsValid(), freeBusyTypeLogicalToDisplay(), freeBusyTypeLogicalToOdbc(), freeBusyTypeNormalize(), freeBusyTypeSet()
property identifier as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.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 %Boolean (XMLNAME = "overbooked", XMLPROJECTION = "ATTRIBUTE");

This slot has already been overbooked, appointments are unlikely to be accepted for this time.

Property methods: overbookedDisplayToLogical(), overbookedGet(), overbookedIsValid(), overbookedLogicalToDisplay(), overbookedLogicalToXSD(), overbookedNormalize(), overbookedSet(), overbookedXSDToLogical()
property schedule as HS.FHIR.DTL.vDSTU2.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 start as %String (MAXLEN = 1000000, XMLNAME = "start", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Date/Time that the slot is to begin.

Property methods: startDisplayToLogical(), startGet(), startIsValid(), startLogicalToDisplay(), startLogicalToOdbc(), startNormalize(), startSet()
property type as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "type", 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.

c80-practice-codes is the PREFERRED FHIR2 ValueSet for codes, but if you need to express meanings not found in c80-practice-codes, you may use codes from any ValueSet.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab