xCaliber healthCare Data Mesh

Slot

Overview

The Slot resource represents a single time interval or availability window for healthcare appointments, admissions and other services.

Use Cases

  • Appointment Scheduling - Check slot availability and book patient appointments.
  • Schedule Optimization - Analyze slot utilization patterns and adjust capacity for demand.
  • Resource Management - Assign appropriate resources like staff and rooms to appointment slots.
  • Patient Self-scheduling - Enable patient self-service appointment booking based on open slots.
  • Waitlist Management - Place patients on slot waitlists and fill cancellations.
  • Workflow Integration - Trigger actions when slots become available like notifications.
  • Reporting & Analytics - Generate reports on slot capacity, utilization, availability by department.
  • Consolidated Scheduling - Unify slot views across various health facility scheduling systems.
  • Referral Management - Share specialty slot availability to coordinate referred appointments.
  • Telehealth - Manage slots for virtual appointments and integrate with telemedicine workflows.

EHR Data Model

EHRSupported?Mapped Source Object
AthenaAppointment Slot
ElationN/A
EpicN/A

Object Definition

{
  "resourceType": "Slot",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t25 Dec 2013 9:15am - 9:30am: <b>Busy</b> Physiotherapy\n\t\t</div>"
  },
  "serviceCategory": [
    {
      "coding": [
        {
          "code": "17",
          "display": "General Practice"
        }
      ]
    }
  ],
  "serviceType": [
    {
      "coding": [
        {
          "code": "57",
          "display": "Immunization"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "code": "408480009",
          "display": "Clinical immunology"
        }
      ]
    }
  ],
  "appointmentType": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
        "code": "WALKIN",
        "display": "A previously unscheduled walk-in visit"
      }
    ]
  },
  "schedule": {
    "reference": "Schedule/example"
  },
  "status": "free",
  "start": "2013-12-25T09:15:00Z",
  "end": "2013-12-25T09:30:00Z",
  "comment": "Assessments should be performed before requesting appointments in this slot.",
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeSlotThis is a Slot resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedBackboneElementThese 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.
extensionExtensionMay 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.
modifierExtensionExtensionMay 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).
identifierIdentifierExternal Ids for this item.
serviceCategoryCodeableConceptA broad categorization of the service that is to be performed during this appointment.
serviceTypeCodeableConceptThe 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.
specialtyCodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentTypeCodeableConceptThe style of appointment or patient that may be booked in the slot (not service type).
scheduleReferenceThe schedule resource that this slot defines an interval of status information.
statuscodebusy | free | busy-unavailable | busy-tentative | entered-in-error.
startinstantDate/Time that the slot is to begin.
endinstantDate/Time that the slot is to conclude.
overbookedbooleanThis slot has already been overbooked, appointments are unlikely to be accepted for this time.
commentstringComments on the slot to describe any extended information. Such as custom constraints on the slot.

Extensions

NameURL

Operations & APIs

Slot-GET

Slot-POST

Slot ID-GET

Slot ID-PUT

Slot ID-DELETE