Schedule - FHIR v3.5.0

R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

12.12.6 Resource Schedule - Detailed Descriptions

Patient Administration

Work Group

Maturity Level: 3

Trial Use

Compartments: Device, Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the Schedule resource.

Schedule
Element Id	Schedule
Definition	A container for slots of time that may be available for booking appointments.
Control	1..1
Type	DomainResource
Alternate Names	Availability
Schedule.identifier
Element Id	Schedule.identifier
Definition	External Ids for this item.
Note	This is a business identifer, not a resource identifier (see discussion)
Control	0..*
Type	Identifier
Summary	true
Schedule.active
Element Id	Schedule.active
Definition	Whether this schedule record is in active use or should not be used (such as was entered in error).
Control	0..1
Type	boolean
Is Modifier	true (Reason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid)
Meaning if Missing	This resource is generally assumed to be active if no value is provided for the active element
Summary	true
Comments	This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Schedule.serviceCategory
Element Id	Schedule.serviceCategory
Definition	A broad categorization of the service that is to be performed during this appointment.
Control	0..*
Terminology Binding	Service category (Example)
Type	CodeableConcept
Summary	true
Schedule.serviceType
Element Id	Schedule.serviceType
Definition	The specific service that is to be performed during this appointment.
Control	0..*
Terminology Binding	Service type (Example)
Type	CodeableConcept
Summary	true
Schedule.specialty
Element Id	Schedule.specialty
Definition	The specialty of a practitioner that would be required to perform the service requested in this appointment.
Control	0..*
Terminology Binding	Practice Setting Code Value Set (Preferred)
Type	CodeableConcept
Summary	true
Schedule.actor
Element Id	Schedule.actor
Definition	The resource this Schedule resource is providing availability information for. These are usually expected to be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.
Control	1..*
Type	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Device \| HealthcareService \| Location)
Summary	true
Comments	The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room(location) are always required by a system.
Schedule.planningHorizon
Element Id	Schedule.planningHorizon
Definition	The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
Control	0..1
Type	Period
Summary	true
Schedule.comment
Element Id	Schedule.comment
Definition	Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
Control	0..1
Type	string