Appointment

ResourceBase · WorkflowTrial useMaturity 3

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

17 of 17 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	External Ids for this item
statusRequired?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlistBinding (required): appointmentstatus
cancelationReasonΣ	0..1	CodeableConcept	The coded reason for the appointment being cancelledBinding (example): appointment-cancellation-reason
serviceCategoryΣ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointmentBinding (example): service-category
serviceTypeΣ	0..*	CodeableConcept	The specific service that is to be performed during this appointmentBinding (example): service-type
specialtyΣ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointmentBinding (preferred): c80-practice-codes
appointmentTypeΣ	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type)Binding (preferred): v2-0276
reasonCodeΣ	0..*	CodeableConcept	Coded reason this appointment is scheduledBinding (preferred): encounter-reason
reasonReference	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the appointment is to take place (resource)
priority	0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description	0..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation	0..*	Reference(Resource)	Additional information to support the appointment
startΣ	0..1	instant	When appointment is to take place
endΣ	0..1	instant	When appointment is to conclude
minutesDuration	0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot	0..*	Reference(Slot)	The slots that this appointment is filling
created	0..1	dateTime	The date that this appointment was initially created
comment	0..1	string	Additional comments
patientInstruction	0..1	string	Detailed information and instructions for the patient
basedOn	0..*	Reference(ServiceRequest)	The service request this appointment is allocated to assess
participantRequired	1..*	BackboneElement	Participants involved in appointment
typeΣ	0..*	CodeableConcept	Role of participant in the appointmentBinding (extensible): encounter-participant-type
actorΣ	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person, Location/HealthcareService or Device
requiredΣ	0..1	code	required | optional | information-onlyBinding (required): participantrequired
statusRequiredΣ	1..1	code	accepted | declined | tentative | needs-actionBinding (required): participationstatus
period	0..1	Period	Participation period of the actor
requestedPeriod	0..*	Period	Potential date/time interval(s) requested to allocate the appointment within

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Appointment?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

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

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition