> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Schedule

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

## Properties

| Name | Required | Type | Description |
| - | - | - | - |
| identifier | No | [Identifier](/medical-api/fhir/data-types/identifier)\[] | External Ids for this item |
| active | No | boolean | Whether this schedule is in active use |
| serviceCategory | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[] | High-level category |
| serviceType | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[] | Specific service |
| specialty | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[] | Type of specialty needed |
| actor | Yes | Reference\<[Patient](/medical-api/fhir/resources/patient) / [Practitioner](/medical-api/fhir/resources/practitioner) / [PractitionerRole](/medical-api/fhir/resources/practitionerrole) / [RelatedPerson](/medical-api/fhir/resources/relatedperson) / [Device](/medical-api/fhir/resources/device) / [HealthcareService](/medical-api/fhir/resources/healthcareservice) / [Location](/medical-api/fhir/resources/location)>\[] | Resource(s) that availability information is being provided for |
| planningHorizon | No | [Period](/medical-api/fhir/data-types/period) | Period of time covered by schedule |
| comment | No | string | Comments on availability |

## Search Parameters

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

## Inherited Properties

| Name | Required | Type | Description |
| - | - | - | - |
| id | No | string | Logical id of this artifact |
| meta | No | [Meta](/medical-api/fhir/data-types/meta) | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | [Narrative](/medical-api/fhir/data-types/narrative) | Text summary of the resource, for human interpretation |
| contained | No | Resource\[] | Contained, inline Resources |
| extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored |

To view the FHIR specification for this resource, see [Schedule](https://www.hl7.org/fhir/StructureDefinition/Schedule).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.