Others titles

  • FHIR Schedule Resource
  • Electronic Health Records Exchange Through FHIR


  • FHIR
  • HL7
  • Medical Terminology
  • Processes Data
  • Processes Information
  • Processes Documentation
  • Health Information Exchange
  • Electronic Health Records
  • FHIR Smart
  • Smart on FHIR


Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.

Log in to download

Get The Data

  • The data in CSV format DOWNLOAD
  • Metadata in Human Readable format (PDF) DOWNLOAD
  • Metadata in Machine Readable format (JSON) DOWNLOAD
Your Data License
  • Research
    Non-Commercial, Share-Alike, Attribution Free Forever
  • Commercial
    Commercial Use, Remix & Adapt, White Label Buy Subscription


The schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available.

A schedule controls the dates and times available for the performance of a service and/or the use of a resource. One schedule applies to one service or resource, since each service or resource can be reserved independently of the others.
If two or more services, people, locations, or things cannot be reserved independently of one another, they are considered to be one activity or resource.

A schedule consists of slots of time during which the controlled service or resource is potentially available for provision or use. Slots are categorized as open, booked, or blocked. An open slot on a schedule indicates that the service or resource is available for provision or use during that period of time. A booked slot indicates that the service or resource is not available during the time period, because an appointment has been scheduled. A blocked slot indicates that a service or resource is unavailable for reasons other than a scheduled appointment.

The real-world, non-automated analogue of the schedule described above is a standard appointment book. These books are generally organized with rows of time slots, during which a service or resource is available.

A slot is one unit on a schedule. A slot represents the smallest unit of time or quantity that a service or resource may be booked. Depending on the nature of the service or resource, there may be more than one defined slot at a given instant of time. For example, if a service is an open group therapy session with twelve available seats, then there are twelve slots for the given block of time.

The schedule belongs to a single instance of a service or resource. This is normally a HealthcareService, Practitioner, Location or Device. In the case where a single resource can provide different services, potentially at different location, then the schedulable resource is considered the composite of the actors.
For example, if a practitioner can provide services at multiple locations, they might have one schedule per location, where each schedule includes both the practitioner and location actors. When booking an appointment with multiple schedulable resources, multiple schedules may need to be checked depending on the configuration of the system.

If an appointment has two practitioners, a specific medical device and a room then there could be a schedule for each of these resources that may need to be consulted to ensure that no collisions occur.
If the schedule needed to be consulted, then there would be one created covering the planning horizon for the time of the appointment.

About this Dataset

Data Info

Date Created


Last Modified




Update Frequency


Temporal Coverage


Spatial Coverage

United States


John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements


Source Citation



FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Schedule Resource, Electronic Health Records Exchange Through FHIR

Data Fields

Name Description Type Constraints
Concept_NameName of the concept in the FHIR structurestringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its usestring-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
RequiredThe value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value.string-
ConstThe value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword.string-

Data Preview

Concept NameComputer Ready NameTypeDollar RefDescriptionItemsRequiredConst
ScheduleresourceTypeThis is a Schedule resourceSchedule
Scheduleid#/definitions/idThe logical id of the resource as used in the URL for the resource. Once assigned this value never changes.
Schedulemeta#/definitions/MetaThe 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.
ScheduleimplicitRules#/definitions/uriA 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.
Schedule_implicitRules#/definitions/ElementExtensions for implicitRules
Schedulelanguage#/definitions/codeThe base language in which the resource is written.
Schedule_language#/definitions/ElementExtensions for language
Scheduletext#/definitions/NarrativeA 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.
SchedulecontainedarrayThese 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.{'$ref': '#/definitions/ResourceList'}
ScheduleextensionarrayMay 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.{'$ref': '#/definitions/Extension'}