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

# Appointment

> A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

## Properties

| Name                  | Required | Type                                                                                                                                                                                                                                                                                                                                                                                                                         | Description                                                                                                       |
| --------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| identifier            | No       | [Identifier](/medical-api/fhir/data-types/identifier)\[]                                                                                                                                                                                                                                                                                                                                                                     | External Ids for this item                                                                                        |
| status                | Yes      | code                                                                                                                                                                                                                                                                                                                                                                                                                         | proposed / pending / booked / arrived / fulfilled / cancelled / noshow / entered-in-error / checked-in / waitlist |
| cancelationReason     | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)                                                                                                                                                                                                                                                                                                                                                              | The coded reason for the appointment being cancelled                                                              |
| serviceCategory       | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[]                                                                                                                                                                                                                                                                                                                                                           | A broad categorization of the service that is to be performed during this appointment                             |
| serviceType           | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[]                                                                                                                                                                                                                                                                                                                                                           | The specific service that is to be performed during this appointment                                              |
| specialty             | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[]                                                                                                                                                                                                                                                                                                                                                           | The specialty of a practitioner that would be required to perform the service requested in this appointment       |
| appointmentType       | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)                                                                                                                                                                                                                                                                                                                                                              | The style of appointment or patient that has been booked in the slot (not service type)                           |
| reasonCode            | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[]                                                                                                                                                                                                                                                                                                                                                           | Coded reason this appointment is scheduled                                                                        |
| reasonReference       | No       | Reference\<[Condition](/medical-api/fhir/resources/condition) / [Procedure](/medical-api/fhir/resources/procedure) / [Observation](/medical-api/fhir/resources/observation) / [ImmunizationRecommendation](/medical-api/fhir/resources/immunizationrecommendation)>\[]                                                                                                                                                       | Reason the appointment is to take place (resource)                                                                |
| priority              | No       | unsignedInt                                                                                                                                                                                                                                                                                                                                                                                                                  | Used to make informed decisions if needing to re-prioritize                                                       |
| description           | No       | string                                                                                                                                                                                                                                                                                                                                                                                                                       | Shown on a subject line in a meeting request, or appointment list                                                 |
| supportingInformation | No       | Reference\<Resource>\[]                                                                                                                                                                                                                                                                                                                                                                                                      | Additional information to support the appointment                                                                 |
| start                 | No       | instant                                                                                                                                                                                                                                                                                                                                                                                                                      | When appointment is to take place                                                                                 |
| end                   | No       | instant                                                                                                                                                                                                                                                                                                                                                                                                                      | When appointment is to conclude                                                                                   |
| minutesDuration       | No       | positiveInt                                                                                                                                                                                                                                                                                                                                                                                                                  | Can be less than start/end (e.g. estimate)                                                                        |
| slot                  | No       | Reference\<[Slot](/medical-api/fhir/resources/slot)>\[]                                                                                                                                                                                                                                                                                                                                                                      | The slots that this appointment is filling                                                                        |
| created               | No       | dateTime                                                                                                                                                                                                                                                                                                                                                                                                                     | The date that this appointment was initially created                                                              |
| comment               | No       | string                                                                                                                                                                                                                                                                                                                                                                                                                       | Additional comments                                                                                               |
| patientInstruction    | No       | string                                                                                                                                                                                                                                                                                                                                                                                                                       | Detailed information and instructions for the patient                                                             |
| basedOn               | No       | Reference\<[ServiceRequest](/medical-api/fhir/resources/servicerequest)>\[]                                                                                                                                                                                                                                                                                                                                                  | The service request this appointment is allocated to assess                                                       |
| participant           | Yes      | AppointmentParticipant                                                                                                                                                                                                                                                                                                                                                                                                       | Participants involved in appointment                                                                              |
| - id                  | No       | string                                                                                                                                                                                                                                                                                                                                                                                                                       | Unique id for inter-element referencing                                                                           |
| - 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 even if unrecognized                                                            |
| - type                | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[]                                                                                                                                                                                                                                                                                                                                                           | Role of participant in the appointment                                                                            |
| - actor               | No       | 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)> | Person, Location/HealthcareService or Device                                                                      |
| - required            | No       | code                                                                                                                                                                                                                                                                                                                                                                                                                         | required / optional / information-only                                                                            |
| - status              | Yes      | code                                                                                                                                                                                                                                                                                                                                                                                                                         | accepted / declined / tentative / needs-action                                                                    |
| - period              | No       | [Period](/medical-api/fhir/data-types/period)                                                                                                                                                                                                                                                                                                                                                                                | Participation period of the actor                                                                                 |
| requestedPeriod       | No       | [Period](/medical-api/fhir/data-types/period)\[]                                                                                                                                                                                                                                                                                                                                                                             | Potential date/time interval(s) requested to allocate the appointment within                                      |

## Search Parameters

| Name             | Type      | Description                                                                                                                                                       | Expression                        |
| ---------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| actor            | reference | Any one of the individuals participating in the appointment                                                                                                       | Appointment.participant.actor     |
| appointment-type | token     | The style of appointment or patient that has been booked in the slot (not service type)                                                                           | Appointment.appointmentType       |
| based-on         | reference | The service request this appointment is allocated to assess                                                                                                       | Appointment.basedOn               |
| date             | date      | Appointment date/time.                                                                                                                                            | Appointment.start                 |
| identifier       | token     | An Identifier of the Appointment                                                                                                                                  | Appointment.identifier            |
| location         | reference | This location is listed in the participants of the appointment                                                                                                    | Appointment.participant.actor     |
| part-status      | token     | The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. | Appointment.participant.status    |
| patient          | reference | One of the individuals of the appointment is this patient                                                                                                         | Appointment.participant.actor     |
| practitioner     | reference | One of the individuals of the appointment is this practitioner                                                                                                    | Appointment.participant.actor     |
| reason-code      | token     | Coded reason this appointment is scheduled                                                                                                                        | Appointment.reasonCode            |
| reason-reference | reference | Reason the appointment is to take place (resource)                                                                                                                | Appointment.reasonReference       |
| service-category | token     | A broad categorization of the service that is to be performed during this appointment                                                                             | Appointment.serviceCategory       |
| service-type     | token     | The specific service that is to be performed during this appointment                                                                                              | Appointment.serviceType           |
| slot             | reference | The slots that this appointment is filling                                                                                                                        | Appointment.slot                  |
| specialty        | token     | The specialty of a practitioner that would be required to perform the service requested in this appointment                                                       | Appointment.specialty             |
| status           | token     | The overall status of the appointment                                                                                                                             | Appointment.status                |
| supporting-info  | reference | Additional information to support the appointment                                                                                                                 | Appointment.supportingInformation |

## 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 [Appointment](https://www.hl7.org/fhir/StructureDefinition/Appointment).
