Appointment | Medplum

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

Elements

Name	Required	Type	Description
identifier		Identifier[0ml	External Ids for this item Details This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
status	✓	code	proposed
cancelationReason		CodeableConcept	The coded reason for the appointment being cancelled Details The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
serviceCategory		CodeableConcept[0ml	A broad categorization of the service that is to be performed during this appointment Details A broad categorization of the service that is to be performed during this appointment.
serviceType		CodeableConcept[0ml	The specific service that is to be performed during this appointment Details The specific service that is to be performed during this appointment. For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.
specialty		CodeableConcept[0ml	The specialty of a practitioner that would be required to perform the service requested in this appointment Details The specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentType		CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Details The style of appointment or patient that has been booked in the slot (not service type).
reasonCode		CodeableConcept[0ml	Coded reason this appointment is scheduled Details The coded reason that this appointment is being scheduled. This is more clinical than administrative.
reasonReference		Reference< Condition \| Procedure \| Observation \| ImmunizationRecommendation >[]	Reason the appointment is to take place (resource) Details Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
priority		unsignedInt	Used to make informed decisions if needing to re-prioritize Details The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority). Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.
description		string	Shown on a subject line in a meeting request, or appointment list Details The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
supportingInformation		Reference[]	Additional information to support the appointment Details Additional information to support the appointment provided when making the appointment.
start		instant	When appointment is to take place Details Date/Time that the appointment is to take place.
end		instant	When appointment is to conclude Details Date/Time that the appointment is to conclude.
minutesDuration		positiveInt	Can be less than start/end (e.g. estimate) Details Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
slot		Reference< Slot >[]	The slots that this appointment is filling Details The slots from the participants' schedules that will be filled by the appointment.
created		dateTime	The date that this appointment was initially created Details The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment. This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.
comment		string	Additional comments Details Additional comments about the appointment. Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.
patientInstruction		string	Detailed information and instructions for the patient Details While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
basedOn		Reference< ServiceRequest >[]	The service request this appointment is allocated to assess Details The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
participant	✓	AppointmentParticipant[]	Participants involved in appointment Details List of participants involved in the appointment.
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
type		CodeableConcept[]	Role of participant in the appointment Details Role of participant in the appointment. The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.
actor		Reference< Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Device \| HealthcareService \| Location >	Person, Location/HealthcareService or Device Details A Person, Location/HealthcareService or Device that is participating in the appointment.
required		code	required
status	✓	code	accepted
period		Period	Participation period of the actor Details Participation period of the actor.
requestedPeriod		Period[]	Potential date/time interval(s) requested to allocate the appointment within Details A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system. This does not introduce a capacity for recurring appointments.

Search Parameters

Name	Type	Description	Expression
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
end	date	The end time of the Appointment	Appointment.end

Inherited Elements

Name	Type	Description
id	string	Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
meta	Meta	Metadata about the resource Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	A set of rules under which this content was created Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
language	code	Language of the resource content Details The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
text	Narrative	Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
contained	Resource[]	Contained, inline Resources Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
extension	Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension	Extension[]	Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.