GET /Appointment

fhir.org:hl7-fhir-api

Summary: search-type: Search for Appointment instances
Operation ID:
Auth: none
Description

This is a search type

Parameters (27)

_filter (string, query, optional)

Search the contents of the resource's data using a filter

_has (string, query, optional)

Return resources linked to by the given target

_id (string, query, optional)

Logical id of this artifact

_language (string, query, optional)

Language of the resource content

_lastUpdated (?, query, optional)

When the resource version last changed

_list (string, query, optional)

Search the contents of the resource's data using a list

_profile (string, query, optional)

Profiles this resource claims to conform to

_security (string, query, optional)

Security Labels applied to this resource

_source (string, query, optional)

Identifies where the resource comes from

_tag (string, query, optional)

Tags applied to this resource

actor (string, query, optional)

Any one of the individuals participating in the appointment

appointment-type (string, query, optional)

The style of appointment or patient that has been booked in the slot (not service type)

based-on (string, query, optional)

The service request this appointment is allocated to assess

date (?, query, optional)

Appointment date/time.

identifier (string, query, optional)

An Identifier of the Appointment

location (string, query, optional)

This location is listed in the participants of the appointment

part-status (string, query, optional)

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.

patient (string, query, optional)

One of the individuals of the appointment is this patient

practitioner (string, query, optional)

One of the individuals of the appointment is this practitioner

reason-code (string, query, optional)

Coded reason this appointment is scheduled

reason-reference (string, query, optional)

Reason the appointment is to take place (resource)

service-category (string, query, optional)

A broad categorization of the service that is to be performed during this appointment

service-type (string, query, optional)

The specific service that is to be performed during this appointment

slot (string, query, optional)

The slots that this appointment is filling

specialty (string, query, optional)

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

status (string, query, optional)

The overall status of the appointment

supporting-info (string, query, optional)

Additional information to support the appointment

Examples (1)

TitleTypeURLAction
search-type: Search for Appointment instances probe-gate https://hapi.fhir.org/baseR4/Appointment

Probe History

Latency

Status Codes

TimeStatusLatencySize
2026-03-23 10:18:56.580653 200 503ms