STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

Detailed Descriptions for the elements in the Schedule resource.

Schedule
Definition

A container for slot(s) of time that may be available for booking appointments.

Control1..1
Alternate NamesAvailability
Schedule.identifier
Definition

External Ids for this item.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Schedule.active
Definition

Whether this schedule record is in active use, or should not be used (such as was entered in error).

Control0..1
Typeboolean
Is Modifiertrue
Default Valuetrue
Summarytrue
Schedule.serviceCategory
Definition

A broad categorisation of the service that is to be performed during this appointment.

Control0..1
Terminology BindingServiceCategory (Example)
TypeCodeableConcept
Summarytrue
Schedule.serviceType
Definition

The specific service that is to be performed during this appointment.

Control0..*
Terminology BindingServiceType (Example)
TypeCodeableConcept
Summarytrue
Schedule.specialty
Definition

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Control0..*
Terminology BindingPractice Setting Code Value Set (Preferred)
TypeCodeableConcept
Summarytrue
Schedule.actor
Definition

The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.

Control1..1
TypeReference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location)
Summarytrue
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.

Control0..1
TypePeriod
Summarytrue
Schedule.comment
Definition

Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated.

Control0..1
Typestring