# Schedule

Canonical page: https://docs.ovok.com/api/fhir/r4/schedule

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Schedule/[id]` |
| Vread | `GET` | `/fhir/R4/Schedule/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Schedule/[id]` |
| Patch | `PATCH` | `/fhir/R4/Schedule/[id]` |
| Delete | `DELETE` | `/fhir/R4/Schedule/[id]` |
| Create | `POST` | `/fhir/R4/Schedule` |
| Search | `GET` | `/fhir/R4/Schedule` |
| History | `GET` | `/fhir/R4/Schedule/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | External Ids for this item |
| <span id="element-active"></span>`active` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Whether this schedule is in active use |
| <span id="element-service-category"></span>`serviceCategory` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | High-level category |
| <span id="element-service-type"></span>`serviceType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Specific service |
| <span id="element-specialty"></span>`specialty` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Type of specialty needed |
| <span id="element-actor"></span>`actor` | [Reference](/fhir-elements/complex/reference) | `1..*` | Resource(s) that availability information is being provided for |
| <span id="element-planning-horizon"></span>`planningHorizon` | [Period](/fhir-elements/complex/period) | `0..1` | Period of time covered by schedule |
| <span id="element-comment"></span>`comment` | [string](/fhir-elements/primitive/string) | `0..1` | Comments on availability |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `active` | token | Is the schedule in active use |
| `actor` | reference | The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for |
| `date` | date | Search for Schedule resources that have a period that contains this date specified |
| `identifier` | token | A Schedule Identifier |
| `service-category` | token | High-level category |
| `service-type` | token | The type of appointments that can be booked into associated slot(s) |
| `specialty` | token | Type of specialty needed |

## Reference [#reference]

Official FHIR R4 spec: [Schedule](https://hl7.org/fhir/R4/schedule.html).  
Maturity: Trial Use 3 (FMM 3).
