View raw Markdown
type: resource-definitionsresource: Slot

Slot Definitions

<a id="Slot"></a>

Slot

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

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

Cardinality: 0..*

Mappings: rim=n/a; ical=(refer to the Schedule resource for the header mapping details); w5=workflow.scheduling

<a id="Slot.identifier"></a>

Slot.identifier

External Ids for this item

Definition: External Ids for this item.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier

<a id="Slot.serviceCategory"></a>

Slot.serviceCategory

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

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

Cardinality: 0..*

Type: CodeableConcept

Binding: example:service-category

Summary: true

Mappings: w5=FiveWs.class

<a id="Slot.serviceType"></a>

Slot.serviceType

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 Schedule resource

Definition: 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 Schedule resource.

Cardinality: 0..*

Type: CodeableReference

Binding: example:service-type

Summary: true

Mappings: w5=FiveWs.class

<a id="Slot.specialty"></a>

Slot.specialty

The specialty of a practitioner that would be required to perform the service requested in this appointment

Definition: The specialty of a practitioner that would be required to perform the service requested in this appointment.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:c80-practice-codes

Summary: true

Mappings: w5=FiveWs.class

<a id="Slot.appointmentType"></a>

Slot.appointmentType

The style of appointment or patient that may be booked in the slot (not service type)

Definition: The style of appointment or patient that may be booked in the slot (not service type).

Comments: A slot may be allow multiple appointment types, but when booked, would only be used for one of the given appointment types.

Cardinality: 0..*

Type: CodeableConcept

Binding: preferred:v2-0276

Summary: true

Mappings: w5=FiveWs.class

<a id="Slot.schedule"></a>

Slot.schedule

The schedule resource that this slot defines an interval of status information

Definition: The schedule resource that this slot defines an interval of status information.

Cardinality: 1..1

Type: Reference(Schedule)

Summary: true

<a id="Slot.status"></a>

Slot.status

busy | free | busy-unavailable | busy-tentative | entered-in-error

Definition: busy | free | busy-unavailable | busy-tentative | entered-in-error.

Cardinality: 1..1

Type: code

Binding: required:slotstatus

Summary: true

Mappings: ical=FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded

<a id="Slot.start"></a>

Slot.start

Date/Time that the slot is to begin

Definition: Date/Time that the slot is to begin.

Cardinality: 1..1

Type: instant

Summary: true

Mappings: w5=FiveWs.planned; ical=FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded

<a id="Slot.end"></a>

Slot.end

Date/Time that the slot is to conclude

Definition: Date/Time that the slot is to conclude.

Cardinality: 1..1

Type: instant

Summary: true

Mappings: w5=FiveWs.planned; ical=FREEBUSY:19980314T233000Z/(end) If the freeBusyType is BUSY, then this value can be excluded (as shown)

<a id="Slot.overbooked"></a>

Slot.overbooked

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

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

Meaning if Missing: If overbooked is missing, systems may assume that there are still appointments available

Cardinality: 0..1

Type: boolean

<a id="Slot.comment"></a>

Slot.comment

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

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

Cardinality: 0..1

Type: string