Appointment REST Endpoints

Sort by

Task Path Method

Description

Appointment

This topic describes information for the Appointment resource.

Overview

Note:

The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

The Appointment resource represents a scheduled healthcare event. The API supports retrieving and searching appointments, finding appointment availability, booking an appointment, and updating appointment status.

Scheduling workflows use the practitioners, locations, and resource-list-based appointment types configured by the electronic health record (EHR) organization.

Profile Support

US Core 6.1.0 does not define a standalone Appointment profile. This API uses the base FHIR R4 Appointment resource.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
Appointment	DomainResource
Appointment.id	id
Appointment.meta	Meta
Appointment.text	Narrative
Appointment.contained	HealthcareService
Appointment.extension	Extension
Appointment.status	code
Appointment.serviceType	CodeableConcept
Appointment.reasonCode	CodeableConcept
Appointment.cancelationReason	CodeableConcept
Appointment.description	string
Appointment.start	instant
Appointment.end	instant
Appointment.minutesDuration	positiveInt
Appointment.comment	string
Appointment.participant	BackboneElement
Appointment.participant.type	CodeableConcept
Appointment.participant.actor	Reference
Appointment.participant.required	code
Appointment.participant.period	Period
Appointment.participant.status	code
Appointment.patientInstruction	string

Terminology Bindings

Element	Description	Details
Appointment.status	The overall status of the appointment.	AppointmentStatus
Appointment.serviceType	The specific service performed during the appointment.	Service Type
Appointment.cancelationReason	The coded reason the appointment was canceled.	Appointment Cancellation Reason
Appointment.participant.type	The participant's role in the appointment.	Encounter Participant Type
Appointment.participant.status	The participant's acceptance status.	ParticipationStatus

Extensions

ID	Value Type	Description
action-comment	string	The comment associated with an action performed on the appointment.
associated-encounter	Reference(Encounter)	The encounter associated with the appointment.
group-appointment-id	string	The appointment group that contains this appointment.
reschedule-reason	CodeableConcept	The reason the appointment was rescheduled.
is-cancelable	boolean	Whether the appointment can be canceled.
is-reschedulable	boolean	Whether the appointment can be rescheduled.

Appointment

The operations from the Appointment category.

Book an appointment

Method: post

Path: /Appointment/$book

Find available appointments

Method: get

Path: /Appointment/$find

Find available appointments

Method: post

Path: /Appointment/$find

Get a list of appointments

Method: get

Path: /Appointment

Get an appointment by ID

Method: get

Path: /Appointment/{id}

Update an appointment status

Method: patch

Path: /Appointment/{id}