FHIR CI-Build

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

12.16.7 Resource Schedule - Detailed Descriptions

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 Id Schedule
Definition

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

Short Display A container for slots of time that may be available for booking appointments
Cardinality 0..*
Type DomainResource
Alternate Names Availability
Summary false
Schedule.identifier
Element Id Schedule.identifier
Definition

External Ids for this item.

Short Display External Ids for this item
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 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).

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

Short Display High-level category
Cardinality 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.

Short Display Specific service
Cardinality 0..*
Terminology Binding Service Type (Example)
Type CodeableReference(HealthcareService)
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.

Short Display Type of specialty needed
Cardinality 0..*
Terminology Binding Practice Setting Code Value Set (Preferred)
Type CodeableConcept
Summary true
Schedule.name
Element Id Schedule.name
Definition

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

Short Display Human-readable label
Cardinality 0..1
Type string
Summary true
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 Id Schedule.actor
Definition

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

Short Display Resource(s) that availability information is being provided for
Cardinality 1..*
Type Reference(Patient | Practitioner | PractitionerRole | CareTeam | 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 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 Display Period of time covered by schedule
Cardinality 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.

Short Display Comments on availability
Cardinality 0..1
Type markdown
Summary false