SMART Scheduling Links
1.0.0-ballot - STU 1 Ballot International flag

SMART Scheduling Links, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/smart-scheduling-links/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Healthcare Service

The Health Service resource is used to describe a single healthcare service or category of services that are provided by an organization at a location. The location of the services could be virtual, as with telemedicine services. This profile provides a scheduling-optimized view of healthcare service offerings, enabling discovery and booking of appointments when no specific practitioner is required or specified.

Location

Each line of the Location File is a minified JSON object that conveys a physical location where appointments are available.

Practitioner

This profile sets minimum expections for a Practitioner resource

PractitionerRole

Each line of the PractitionerRole File is a minified JSON object that represents a set of roles/locations/specialties/services that a practitioner may perform at an organization for a period of time. The PractitionerRole resource represents the specific roles that practitioners perform at organizations where appointments are available. According to the FHIR R4 PractitionerRole definition, practitioner roles define the specific context in which practitioners provide services, including:

  • Primary care physician roles at specific locations
  • Specialist roles (cardiologist, dermatologist, etc.) with specific availability
  • Nursing roles for various services and locations
  • Pharmacy roles for medication management and immunizations
  • Therapy roles (physical therapy, occupational therapy, etc.)
  • Diagnostic service roles (radiology, laboratory, etc.)
  • Administrative roles that support patient care scheduling
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.

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

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Booking Deep Link

A deep link into the Provider Booking Portal where the user can begin booking this slot.

Booking Phone

A phone number the user can call to book this slot.

Schedule Specialty

The specialty associated with this schedule.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Appointment Type and Reasons

A value set that combines the preferred and required codes from slot.appointmentType and NDH new patient extension, respectively

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example Location

Example Location instance conforming to the SMARTLocation profile.

Example Practitioner

Example Location instance conforming to the SMARTLocation profile.

Example PractitionerRole

Example PractitionerRole instance conforming to the SmartSchedulingPractitionerRole.

Example Schedule

This example demonstrates a Schedule with multiple actors, indicating that general practice appointments are available for practitioner role "doc-smith-role" at location "123". This pattern is commonly used when a specific practitioner role provides services at a specific location.

Example Slot

Example slot that has the booking extensions

ExampleHealhCareService

Example HealthcareService instance conforming to the SmartSchedulingHealthcareService profile.

Organization example

Example of the Organization resource

Slot Accepting New and Existing Patients

A slot that is accepting new and existing patients

Slot Accepting Only Existing Patients

A slot that is accepting only existing patients

doc-smith-role