Appointment

Trial Use 3 Workflow

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Appointment

Interaction	Method	Path
Read	GET	/fhir/R5/Appointment/[id]
Vread	GET	/fhir/R5/Appointment/[id]/_history/[vid]
Update	PUT	/fhir/R5/Appointment/[id]
Patch	PATCH	/fhir/R5/Appointment/[id]
Delete	DELETE	/fhir/R5/Appointment/[id]
Create	POST	/fhir/R5/Appointment
Search	GET	/fhir/R5/Appointment?...
History	GET	/fhir/R5/Appointment/[id]/_history
Type-history	GET	/fhir/R5/Appointment/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	External Ids for this item
status	code	1..1	proposed
cancellationReason	CodeableConcept	0..1	The coded reason for the appointment being cancelled
class	CodeableConcept	0..*	Classification when becoming an encounter
serviceCategory	CodeableConcept	0..*	A broad categorization of the service that is to be performed during this appointment
serviceType	CodeableReference	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)
reason	CodeableReference	0..*	Reason this appointment is scheduled
priority	CodeableConcept	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
replaces	Reference	0..*	Appointment replaced by this Appointment
virtualService	VirtualServiceDetail	0..*	Connection details of a virtual service (e.g. conference call)
supportingInformation	Reference	0..*	Additional information to support the appointment
previousAppointment	Reference	0..1	The previous appointment in a series
originatingAppointment	Reference	0..1	The originating appointment in a recurring set of appointments
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)
requestedPeriod	Period	0..*	Potential date/time interval(s) requested to allocate the appointment within
slot	Reference	0..*	The slots that this appointment is filling
account	Reference	0..*	The set of accounts that may be used for billing for this Appointment
created	dateTime	0..1	The date that this appointment was initially created
cancellationDate	dateTime	0..1	When the appointment was cancelled
note	Annotation	0..*	Additional comments
patientInstruction	CodeableReference	0..*	Detailed information and instructions for the patient
basedOn	Reference	0..*	The request this appointment is allocated to assess
subject	Reference	0..1	The patient or group associated with the appointment
participant	BackboneElement	1..*	Participants involved in appointment
recurrenceId	positiveInt	0..1	The sequence number in the recurrence
occurrenceChanged	boolean	0..1	Indicates that this appointment varies from a recurrence pattern
recurrenceTemplate	BackboneElement	0..*	Details of the recurrence pattern/template used to generate occurrences

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	When the event occurred
group	reference	One of the individuals of the appointment is this patient
identifier	token	Account number
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	The entity that caused the expenses
practitioner	reference	One of the individuals of the appointment is this practitioner
reason-code	token	Reference to a concept (by class)
reason-reference	reference	Reference to a resource (by instance)
requested-period	date	During what period was the Appointment requested to take place
service-category	token	A broad categorization of the service that is to be performed during this appointment
service-type	token	The specific service (by coding) that is to be performed during this appointment
service-type-reference	reference	The specific service (by HealthcareService) 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
subject	reference	One of the individuals of the appointment is this patient
supporting-info	reference	Additional information to support the appointment

Reference

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