# Schedule - SMART Scheduling Links v1.0.0-ballot

## Resource Profile: Schedule 

 
Each line of the Schedule File is a minified JSON object that conveys information about a Schedule to which slots are attached. The Schedule represents a particular healthcare service (e.g., primary care appointments, specialist consultations, or procedures) offered at a specific location or by a specific practitioner role. 

**Example Usage Scenarios**

Schedules can reference multiple actors in the actor array to provide more specific context about the healthcare service. Common patterns include:

* Location-only schedules: Reference only a Location resource, indicating that appointments are available at that location but not tied to a specific practitioner role.
* PractitionerRole-only schedules: Reference only a PractitionerRole resource, indicating appointments with that specific practitioner role regardless of location.
* Location and PractitionerRole schedules: Reference both Location and PractitionerRole resources, indicating appointments for a specific practitioner role at a specific location. This is useful for: 
* Multi-location practices where practitioner roles work at different sites
* Specialty clinics where specific practitioner roles provide services at designated locations
* Healthcare systems where practitioner role schedules vary by location
 

### 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 Schedule Must Have:**

* a serviceType
* at least one actor

**Each Schedule Must Support:**

* a display for the actor

**Usages:**

* Examples for this Profile: [Schedule/ExampleSchedule](Schedule-ExampleSchedule.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-schedule)

### 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-schedule.csv), [Excel](../StructureDefinition-smart-scheduling-schedule.xlsx), [Schematron](../StructureDefinition-smart-scheduling-schedule.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "smart-scheduling-schedule",
  "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-schedule",
  "version" : "1.0.0-ballot",
  "name" : "SmartSchedulingSchedule",
  "title" : "Schedule",
  "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 Schedule File is a minified JSON object that conveys information about a Schedule \nto which slots are attached. The Schedule represents a particular healthcare service (e.g., primary care \nappointments, specialist consultations, or procedures) offered at a specific location or by a specific \npractitioner role.",
  "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" : "Schedule",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Schedule",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Schedule",
      "path" : "Schedule"
    },
    {
      "id" : "Schedule.serviceType",
      "path" : "Schedule.serviceType",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Schedule.actor",
      "path" : "Schedule.actor",
      "mustSupport" : true
    },
    {
      "id" : "Schedule.actor.reference",
      "path" : "Schedule.actor.reference",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Schedule.actor.display",
      "path" : "Schedule.actor.display",
      "mustSupport" : true
    }]
  }
}

```
