Skip to main content

Slot

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

Elements

NameRequiredTypeDescription
identifierIdentifier[]

External Ids for this item

Details

External Ids for this item.

serviceCategoryCodeableConcept[]

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

Details

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

serviceTypeCodeableConcept[]

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

Details

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.

specialtyCodeableConcept[]

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

Details

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

appointmentTypeCodeableConcept

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

Details

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

scheduleReference<Schedule>

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

Details

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

statuscode

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

Details

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

startinstant

Date/Time that the slot is to begin

Details

Date/Time that the slot is to begin.

endinstant

Date/Time that the slot is to conclude

Details

Date/Time that the slot is to conclude.

overbookedboolean

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

Details

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

commentstring

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

Details

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

Search Parameters

NameTypeDescriptionExpression
appointment-typetokenThe style of appointment or patient that may be booked in the slot (not service type)Slot.appointmentType
identifiertokenA Slot IdentifierSlot.identifier
schedulereferenceThe Schedule Resource that we are seeking a slot withinSlot.schedule
service-categorytokenA broad categorization of the service that is to be performed during this appointmentSlot.serviceCategory
service-typetokenThe type of appointments that can be booked into the slotSlot.serviceType
specialtytokenThe specialty of a practitioner that would be required to perform the service requested in this appointmentSlot.specialty
startdateAppointment date/time.Slot.start
statustokenThe free/busy status of the appointmentSlot.status
enddateThe end time of the SlotSlot.end

Inherited Elements

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

metaMeta

Metadata about the resource

Details

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.

implicitRulesuri

A set of rules under which this content was created

Details

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.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

textNarrative

Text summary of the resource, for human interpretation

Details

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.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

containedResource[]

Contained, inline Resources

Details

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.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

extensionExtension[]

Additional content defined by implementations

Details

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.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

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).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.