FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Patient Administration icon 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.

Short DisplayA container for slots of time that may be available for booking appointments
Cardinality0..*
TypeDomainResource
Alternate NamesAvailability
Summaryfalse
Schedule.identifier
Element IdSchedule.identifier
Definition

External Ids for this item.

Short DisplayExternal 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).

Short DisplayWhether this schedule is in active use
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.

Short DisplayHigh-level category
Cardinality0..*
Terminology BindingServiceCategory (Example)
TypeCodeableConcept
Summarytrue
Schedule.serviceType
Element IdSchedule.serviceType
Definition

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

Short DisplaySpecific service
Cardinality0..*
Terminology BindingServiceType (Example)
TypeCodeableReference(HealthcareService)
Summarytrue
Schedule.specialty
Element IdSchedule.specialty
Definition

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

Short DisplayType of specialty needed
Cardinality0..*
Terminology BindingPractice Setting Code Value Set (Preferred)
TypeCodeableConcept
Summarytrue
Schedule.name
Element IdSchedule.name
Definition

Further description of the schedule as it would be presented to a consumer while searching.

Short DisplayHuman-readable label
Cardinality0..1
Typestring
Summarytrue
Comments

This MAY be used to describe what the schedule is for where it is clearer than just the name of the single actor.

Schedule.actor
Element IdSchedule.actor
Definition

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

Short DisplayResource(s) that availability information is being provided for
Cardinality1..*
TypeReference(Patient | Practitioner | PractitionerRole | CareTeam | 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.

Short DisplayPeriod of time covered by schedule
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.

Short DisplayComments on availability
Cardinality0..1
Typestring
Summaryfalse