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. |
Control | 1..1 |
Alternate Names | Availability |
Schedule.identifier | |
Definition | External Ids for this item. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
Schedule.active | |
Definition | Whether this schedule record is in active use, or should not be used (such as was entered in error). |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Default Value | true |
Summary | true |
Schedule.serviceCategory | |
Definition | A broad categorisation of the service that is to be performed during this appointment. |
Control | 0..1 |
Terminology Binding | ServiceCategory (Example) |
Type | CodeableConcept |
Summary | true |
Schedule.serviceType | |
Definition | The specific service that is to be performed during this appointment. |
Control | 0..* |
Terminology Binding | ServiceType (Example) |
Type | CodeableConcept |
Summary | true |
Schedule.specialty | |
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment. |
Control | 0..* |
Terminology Binding | Practice Setting Code Value Set (Preferred) |
Type | CodeableConcept |
Summary | true |
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. |
Control | 1..1 |
Type | Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) |
Summary | true |
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. |
Control | 0..1 |
Type | Period |
Summary | true |
Schedule.comment | |
Definition | Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated. |
Control | 0..1 |
Type | string |