Search Appointments

post

https://fhir-api.zapehr.com/r4b/Appointment/_search

Appointment on the FHIR specification website.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

date

string

Appointment date/time.

identifier

string

An Identifier of the Appointment

specialty

string

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

service-category

string

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

practitioner

string

One of the individuals of the appointment is this practitioner

appointment-type

string

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

part-status

string

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.

service-type

string

The specific service that is to be performed during this appointment

slot

string

The slots that this appointment is filling

reason-code

string

Coded reason this appointment is scheduled

actor

string

Any one of the individuals participating in the appointment

based-on

string

The service request this appointment is allocated to assess

patient

string

One of the individuals of the appointment is this patient

reason-reference

string

Reason the appointment is to take place (resource)

supporting-info

string

Additional information to support the appointment

location

string

This location is listed in the participants of the appointment

status

string

The overall status of the appointment

Responses

401

Unauthorized

403

Forbidden

500

Internal server error

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of Appointments

400Bad request

404Not found