---
type: "search-params"
title: "Appointment Search Parameters"
resource: "Appointment"
---
# Appointment Search Parameters

<a id="actor"></a>

## actor
**Description:** Any one of the individuals participating in the appointment

**Type:** reference

**Expression:** Appointment.participant.actor

**Path:** Appointment.participant.actor

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-actor


<a id="appointment-type"></a>

## appointment-type
**Description:** The style of appointment or patient that has been booked in the slot (not service type)

**Type:** token

**Expression:** Appointment.appointmentType

**Path:** Appointment.appointmentType

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-appointment-type


<a id="based-on"></a>

## based-on
**Description:** The service request this appointment is allocated to assess

**Type:** reference

**Expression:** Appointment.basedOn

**Path:** Appointment.basedOn

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-based-on


<a id="date"></a>

## date
**Description:** Appointment date/time.

**Type:** date

**Expression:** (start | requestedPeriod.start).first()

**Path:** Appointment.start

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-date


<a id="identifier"></a>

## identifier
**Description:** An Identifier of the Appointment

**Type:** token

**Expression:** Appointment.identifier

**Path:** Appointment.identifier

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-identifier


<a id="location"></a>

## location
**Description:** This location is listed in the participants of the appointment

**Type:** reference

**Expression:** Appointment.participant.actor.where(resolve() is Location)

**Path:** Appointment.participant.actor

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-location


<a id="part-status"></a>

## part-status
**Description:** 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.

**Type:** token

**Expression:** Appointment.participant.status

**Path:** Appointment.participant.status

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-part-status


<a id="subject"></a>

## subject
**Description:** One of the individuals of the appointment is this patient

**Type:** reference

**Expression:** Appointment.subject

**Path:** Appointment.subject

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-subject


<a id="patient"></a>

## patient
**Description:** One of the individuals of the appointment is this patient

**Type:** reference

**Expression:** Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient)

**Path:** Appointment.participant.actor

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-patient


<a id="group"></a>

## group
**Description:** One of the individuals of the appointment is this patient

**Type:** reference

**Expression:** Appointment.participant.actor.where(resolve() is Group) | Appointment.subject.where(resolve() is Group)

**Path:** Appointment.participant.actor

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-group


<a id="practitioner"></a>

## practitioner
**Description:** One of the individuals of the appointment is this practitioner

**Type:** reference

**Expression:** Appointment.participant.actor.where(resolve() is Practitioner)

**Path:** Appointment.participant.actor

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-practitioner


<a id="reason-code"></a>

## reason-code
**Description:** Reference to a concept (by class)

**Type:** token

**Expression:** Appointment.reason.concept

**Path:** Appointment.reason.concept

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-reason-code


<a id="reason-reference"></a>

## reason-reference
**Description:** Reference to a resource (by instance)

**Type:** reference

**Expression:** Appointment.reason.reference

**Path:** Appointment.reason.reference

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-reason-reference


<a id="service-category"></a>

## service-category
**Description:** A broad categorization of the service that is to be performed during this appointment

**Type:** token

**Expression:** Appointment.serviceCategory

**Path:** Appointment.serviceCategory

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-service-category


<a id="service-type"></a>

## service-type
**Description:** The specific service (by coding) that is to be performed during this appointment

**Type:** token

**Expression:** Appointment.serviceType.concept

**Path:** Appointment.serviceType.concept

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-service-type


<a id="service-type-reference"></a>

## service-type-reference
**Description:** The specific service (by HealthcareService) that is to be performed during this appointment

**Type:** reference

**Expression:** Appointment.serviceType.reference

**Path:** Appointment.serviceType.reference

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-service-type-reference


<a id="slot"></a>

## slot
**Description:** The slots that this appointment is filling

**Type:** reference

**Expression:** Appointment.slot

**Path:** Appointment.slot

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-slot


<a id="specialty"></a>

## specialty
**Description:** The specialty of a practitioner that would be required to perform the service requested in this appointment

**Type:** token

**Expression:** Appointment.specialty

**Path:** Appointment.specialty

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-specialty


<a id="status"></a>

## status
**Description:** The overall status of the appointment

**Type:** token

**Expression:** Appointment.status

**Path:** Appointment.status

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-status


<a id="supporting-info"></a>

## supporting-info
**Description:** Additional information to support the appointment

**Type:** reference

**Expression:** Appointment.supportingInformation

**Path:** Appointment.supportingInformation

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-supporting-info


<a id="requested-period"></a>

## requested-period
**Description:** During what period was the Appointment requested to take place

**Type:** date

**Expression:** requestedPeriod

**Path:** Appointment.requestedPeriod

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-requestedPeriod


<a id="originating-appointment"></a>

## originating-appointment
**Description:** Reference to the Appointment that contains the recurrence template

**Type:** reference

**Expression:** Appointment.originatingAppointment

**Path:** Appointment.originatingAppointment

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-originating-appointment


<a id="previous-appointment"></a>

## previous-appointment
**Description:** Reference to the Appointment that preceded this appointment in a series

**Type:** reference

**Expression:** Appointment.previousAppointment

**Path:** Appointment.previousAppointment

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-previous-appointment


<a id="occurrence-changed"></a>

## occurrence-changed
**Description:** This Appointment has been changed from the recurrence template

**Type:** token

**Expression:** Appointment.occurrenceChanged

**Path:** Appointment.occurrenceChanged

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-occurrence-changed


<a id="is-recurring"></a>

## is-recurring
**Description:** This Appointment is a part of a recurring series of appointments (has a template or an originating appointment)

**Type:** token

**Expression:** Appointment.recurrenceTemplate.exists() | Appointment.originatingAppointment.exists()

**Path:** Appointment.recurrenceTemplate

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-is-recurring


<a id="has-recurrence-template"></a>

## has-recurrence-template
**Description:** This Appointment contains a recurrence template

**Type:** token

**Expression:** Appointment.recurrenceTemplate.exists()

**Path:** Appointment.recurrenceTemplate

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Appointment-has-recurrence-template