FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) 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 R4 R3 R2

12.12.6 Resource Schedule - Detailed Descriptions

Patient Administration Work Group Maturity Level : 3   Trial Use Security 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.

Control Cardinality 1..1 0..*
Type DomainResource
Alternate Names Availability
Schedule.identifier
Element Id Schedule.identifier
Definition

External Ids for this item.

Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control Cardinality 0..*
Type Identifier
Summary true
Schedule.active
Element Id Schedule.active
Definition

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

Control 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)
Default Value Meaning if Missing true 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 categorisation categorization of the service that is to be performed during this appointment.

Control Cardinality 0..1 0..*
Terminology Binding ServiceCategory 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 Cardinality 0..*
Terminology Binding ServiceType 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 Cardinality 0..*
Terminology Binding Practice Setting Code Value Set ( Preferred )
Type CodeableConcept
Summary true
Schedule.actor
Element Id Schedule.actor
Definition

The resource Slots that reference this Schedule schedule resource is providing provide the availability information for. These are expected details to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson. these referenced resource(s).

Control Cardinality 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 pracitioner practitioner and a room(location) 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 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" "template" for planning outside these dates.

Control 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.

Control Cardinality 0..1
Type string