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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

Interaction	Method	Path
Read	GET	/fhir/R4/Appointment/[id]
Vread	GET	/fhir/R4/Appointment/[id]/_history/[vid]
Update	PUT	/fhir/R4/Appointment/[id]
Patch	PATCH	/fhir/R4/Appointment/[id]
Delete	DELETE	/fhir/R4/Appointment/[id]
Create	POST	/fhir/R4/Appointment
Search	GET	/fhir/R4/Appointment
History	GET	/fhir/R4/Appointment/[id]/_history

Top-level elements

Element	Type	Cardinality	Description
id	string	0..1	Logical id of this artifact
meta	Meta	0..1	Metadata about the resource
implicitRules	uri	0..1	A set of rules under which this content was created
language	code	0..1	Language of the resource content
text	Narrative	0..1	Text summary of the resource, for human interpretation
contained	Resource	0..*	Contained, inline Resources
extension	Extension	0..*	Additional content defined by implementations
modifierExtension	Extension	0..*	Extensions that cannot be ignored
identifier	Identifier	0..*	External Ids for this item
status	code	1..1	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
cancelationReason	CodeableConcept	0..1	The coded reason for the appointment being cancelled
serviceCategory	CodeableConcept	0..*	A broad categorization of the service that is to be performed during this appointment
serviceType	CodeableConcept	0..*	The specific service that is to be performed during this appointment
specialty	CodeableConcept	0..*	The specialty of a practitioner that would be required to perform the service requested in this appointment
appointmentType	CodeableConcept	0..1	The style of appointment or patient that has been booked in the slot (not service type)
reasonCode	CodeableConcept	0..*	Coded reason this appointment is scheduled
reasonReference	Reference	0..*	Reason the appointment is to take place (resource)
priority	unsignedInt	0..1	Used to make informed decisions if needing to re-prioritize
description	string	0..1	Shown on a subject line in a meeting request, or appointment list
supportingInformation	Reference	0..*	Additional information to support the appointment
start	instant	0..1	When appointment is to take place
end	instant	0..1	When appointment is to conclude
minutesDuration	positiveInt	0..1	Can be less than start/end (e.g. estimate)
slot	Reference	0..*	The slots that this appointment is filling
created	dateTime	0..1	The date that this appointment was initially created
comment	string	0..1	Additional comments
patientInstruction	string	0..1	Detailed information and instructions for the patient
basedOn	Reference	0..*	The service request this appointment is allocated to assess
participant	BackboneElement	1..*	Participants involved in appointment
requestedPeriod	Period	0..*	Potential date/time interval(s) requested to allocate the appointment within

Resource-specific search parameters

Parameter	Type	Description
actor	reference	Any one of the individuals participating in the appointment
appointment-type	token	The style of appointment or patient that has been booked in the slot (not service type)
based-on	reference	The service request this appointment is allocated to assess
date	date	Appointment date/time.
identifier	token	An Identifier of the Appointment
location	reference	This location is listed in the participants of the appointment
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.
patient	reference	One of the individuals of the appointment is this patient
practitioner	reference	One of the individuals of the appointment is this practitioner
reason-code	token	Coded reason this appointment is scheduled
reason-reference	reference	Reason the appointment is to take place (resource)
service-category	token	A broad categorization of the service that is to be performed during this appointment
service-type	token	The specific service that is to be performed during this appointment
slot	reference	The slots that this appointment is filling
specialty	token	The specialty of a practitioner that would be required to perform the service requested in this appointment
status	token	The overall status of the appointment
supporting-info	reference	Additional information to support the appointment

Reference

Official FHIR R4 spec: Appointment.
Maturity: Trial Use 3 (FMM 3).