# Slot - SMART Scheduling Links v1.0.0-ballot

## Resource Profile: Slot 

 
Each line of the Slot File is a minified JSON object that conveys information about an appointment slot. Publishers are encouraged to represent slots with fine-grained timing details (e.g. representing appointments at specific times of the day), but MAY represent slots with coarse grained timing (e.g., "between 9 a.m. and 5 p.m." or "between noon and five p.m."). 

**Example Usage Scenarios**

The following are example usage scenarios for the SMART Scheduling Links Slot profile:

* Find course-grained (e.g. 9a - 6p) slots for a given schedule
* Find fine-grained slots for a given schedule
* Filter available slots for whether they accept new and/or existing patients

### Mandatory and Must Support Data Elements

The following data elements must always be present or must be supported if the data is present in the sending system. They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

**Each Slot Must Have:**

* id
* schedule
* status
* start
* end

**Each Slot Must Support:**

* appointmentType
* booking deep link
* booking phone number

**Profile Specific Implementation Guidance:**

When publishing a Slot with `"status": "free"`, Publishers should ensure that the Slot is in fact available for booking, given current business rules. For example, if a provider requires certain prerequisites to be met before an appoinmtnet can be booked (such as referrals, prior authorization, or specific patient elgibility criteria), then the provider SHOULD NOT advertise the slot as available unless those requirements are satisfied.

**Usages:**

* Examples for this Profile: [Slot/AcceptNewAndExistingPatients](Slot-AcceptNewAndExistingPatients.md), [Slot/AcceptOnlyExistingPatients](Slot-AcceptOnlyExistingPatients.md) and [Slot/ExampleSlot](Slot-ExampleSlot.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/hl7.fhir.uv.smart-scheduling-links|current/StructureDefinition/smart-scheduling-slot)

### Formal Views of Profile Content

 [Description Differentials, Snapshots, and other representations](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](../StructureDefinition-smart-scheduling-slot.csv), [Excel](../StructureDefinition-smart-scheduling-slot.xlsx), [Schematron](../StructureDefinition-smart-scheduling-slot.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "smart-scheduling-slot",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "pa"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 2,
    "_valueInteger" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/uv/smart-scheduling-links/ImplementationGuide/hl7.fhir.uv.smart-scheduling-links"
      }]
    }
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use",
    "_valueCode" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/uv/smart-scheduling-links/ImplementationGuide/hl7.fhir.uv.smart-scheduling-links"
      }]
    }
  }],
  "url" : "http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/smart-scheduling-slot",
  "version" : "1.0.0-ballot",
  "name" : "SmartSchedulingSlot",
  "title" : "Slot",
  "status" : "active",
  "date" : "2026-04-01T20:39:00+00:00",
  "publisher" : "HL7 International / Patient Administration",
  "contact" : [{
    "name" : "HL7 International / Patient Administration",
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/pafm"
    },
    {
      "system" : "email",
      "value" : "pafm@lists.hl7.org"
    }]
  }],
  "description" : "Each line of the Slot File is a minified JSON object that conveys information \nabout an appointment slot. Publishers are encouraged to represent slots with \nfine-grained timing details (e.g. representing appointments at specific times \nof the day), but MAY represent slots with coarse grained \ntiming (e.g., \"between 9 a.m. and 5 p.m.\" or \"between noon and five p.m.\").",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "ical",
    "uri" : "http://ietf.org/rfc/2445",
    "name" : "iCalendar"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Slot",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Slot",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Slot",
      "path" : "Slot"
    },
    {
      "id" : "Slot.extension",
      "path" : "Slot.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "ordered" : false,
        "rules" : "open"
      }
    },
    {
      "id" : "Slot.extension:bookingDeepLink",
      "path" : "Slot.extension",
      "sliceName" : "bookingDeepLink",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/booking-deep-link"]
      }]
    },
    {
      "id" : "Slot.extension:bookingPhone",
      "path" : "Slot.extension",
      "sliceName" : "bookingPhone",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/booking-phone"]
      }]
    },
    {
      "id" : "Slot.appointmentType",
      "path" : "Slot.appointmentType",
      "mustSupport" : true,
      "binding" : {
        "strength" : "preferred",
        "valueSet" : "http://hl7.org/fhir/uv/smart-scheduling-links/ValueSet/appointment-type-and-reasons-vs"
      }
    },
    {
      "id" : "Slot.schedule",
      "path" : "Slot.schedule",
      "mustSupport" : true
    },
    {
      "id" : "Slot.status",
      "path" : "Slot.status",
      "mustSupport" : true
    },
    {
      "id" : "Slot.start",
      "path" : "Slot.start",
      "mustSupport" : true
    },
    {
      "id" : "Slot.end",
      "path" : "Slot.end",
      "mustSupport" : true
    }]
  }
}

```
