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
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | External Ids for this item |
active | boolean | 0..1 | Whether this schedule is in active use |
serviceCategory | CodeableConcept | 0..* | High-level category |
serviceType | CodeableConcept | 0..* | Specific service |
specialty | CodeableConcept | 0..* | Type of specialty needed |
actor | Reference | 1..* | Resource(s) that availability information is being provided for |
planningHorizon | Period | 0..1 | Period of time covered by schedule |
comment | string | 0..1 | Comments on availability |
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
Official FHIR R4 spec: Schedule.
Maturity: Trial Use 3 (FMM 3).