Release 4

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). 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

Patient Administration Work GroupMaturity Level: 3 Trial UseSecurity Category: Business Compartments: Device, Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the Schedule resource.

Schedule
Element IdSchedule
Definition

A container for slots of time that may be available for booking appointments.

Cardinality0..*
TypeDomainResource
Alternate NamesAvailability
Schedule.identifier
Element IdSchedule.identifier
Definition

External Ids for this item.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
Schedule.active
Element IdSchedule.active
Definition

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

Cardinality0..1
Typeboolean
Is Modifiertrue (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 MissingThis resource is generally assumed to be active if no value is provided for the active element
Summarytrue
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 IdSchedule.serviceCategory
Definition

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

Cardinality0..*
Terminology BindingService category (Example)
TypeCodeableConcept
Summarytrue
Schedule.serviceType
Element IdSchedule.serviceType
Definition

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

Cardinality0..*
Terminology BindingService type (Example)
TypeCodeableConcept
Summarytrue
Schedule.specialty
Element IdSchedule.specialty
Definition

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

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

Slots that reference this schedule resource provide the availability details to these referenced resource(s).

Cardinality1..*
TypeReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)
Summarytrue
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 IdSchedule.planningHorizon
Definition

The period of time that the slots that reference 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.

Cardinality0..1
TypePeriod
Summarytrue
Schedule.comment
Element IdSchedule.comment
Definition

Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Cardinality0..1
Typestring