description: 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). package_name: hl7.fhir.r5.examples derivation: specialization name: Appointment type: Appointment elements: description: {isModifier: false, short: 'Shown on a subject line in a meeting request, or appointment list', type: string, mustSupport: false, isSummary: false, index: 10} serviceCategory: isModifier: false short: A broad categorization of the service that is to be performed during this appointment type: CodeableConcept mustSupport: false array: true binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/service-category'} isSummary: true index: 4 slot: isModifier: false short: The slots that this appointment is filling refers: ['http://hl7.org/fhir/StructureDefinition/Slot'] type: Reference mustSupport: false array: true isSummary: false index: 20 previousAppointment: isModifier: false short: The previous appointment in a series refers: ['http://hl7.org/fhir/StructureDefinition/Appointment'] type: Reference mustSupport: false isSummary: false index: 14 originatingAppointment: isModifier: false short: The originating appointment in a recurring set of appointments refers: ['http://hl7.org/fhir/StructureDefinition/Appointment'] type: Reference mustSupport: false isSummary: false index: 15 recurrenceId: {isModifier: false, short: The sequence number in the recurrence, type: positiveInt, mustSupport: false, isSummary: false, index: 34} cancellationDate: {isModifier: false, short: When the appointment was cancelled, type: dateTime, mustSupport: false, isSummary: false, index: 23} specialty: isModifier: false short: The specialty of a practitioner that would be required to perform the service requested in this appointment type: CodeableConcept mustSupport: false array: true binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/c80-practice-codes'} isSummary: true index: 6 occurrenceChanged: {isModifier: false, short: Indicates that this appointment varies from a recurrence pattern, type: boolean, mustSupport: false, isSummary: false, index: 35} requestedPeriod: {isModifier: false, short: Potential date/time interval(s) requested to allocate the appointment within, type: Period, mustSupport: false, array: true, isSummary: false, index: 19} patientInstruction: {isModifier: false, short: Detailed information and instructions for the patient, type: CodeableReference, mustSupport: false, array: true, isSummary: false, index: 25} recurrenceTemplate: isModifier: false short: Details of the recurrence pattern/template used to generate occurrences index: 36 type: BackboneElement mustSupport: false array: true elements: timezone: isModifier: false short: The timezone of the occurrences type: CodeableConcept mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/timezones|5.0.0-draft-final'} isSummary: false index: 37 lastOccurrenceDate: {isModifier: false, short: The date when the recurrence should end, type: date, mustSupport: false, isSummary: false, index: 39} yearlyTemplate: isModifier: false short: Information about yearly recurring appointments type: BackboneElement mustSupport: false isSummary: false index: 56 elements: yearInterval: {isModifier: false, short: Recurs every nth year, type: positiveInt, mustSupport: false, isSummary: false, index: 57} required: [yearInterval] monthlyTemplate: isModifier: false short: Information about monthly recurring appointments type: BackboneElement mustSupport: false isSummary: false index: 51 elements: dayOfMonth: {isModifier: false, short: Recurs on a specific day of the month, type: positiveInt, mustSupport: false, isSummary: false, index: 52} nthWeekOfMonth: isModifier: false short: Indicates which week of the month the appointment should occur type: Coding mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/week-of-month|5.0.0-draft-final'} isSummary: false index: 53 dayOfWeek: isModifier: false short: Indicates which day of the week the appointment should occur type: Coding mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/days-of-week|5.0.0-draft-final'} isSummary: false index: 54 monthInterval: {isModifier: false, short: Recurs every nth month, type: positiveInt, mustSupport: false, isSummary: false, index: 55} required: [monthInterval] weeklyTemplate: isModifier: false short: Information about weekly recurring appointments type: BackboneElement mustSupport: false isSummary: false index: 42 elements: monday: {isModifier: false, short: Recurs on Mondays, type: boolean, mustSupport: false, isSummary: false, index: 43} tuesday: {isModifier: false, short: Recurs on Tuesday, type: boolean, mustSupport: false, isSummary: false, index: 44} wednesday: {isModifier: false, short: Recurs on Wednesday, type: boolean, mustSupport: false, isSummary: false, index: 45} thursday: {isModifier: false, short: Recurs on Thursday, type: boolean, mustSupport: false, isSummary: false, index: 46} friday: {isModifier: false, short: Recurs on Friday, type: boolean, mustSupport: false, isSummary: false, index: 47} saturday: {isModifier: false, short: Recurs on Saturday, type: boolean, mustSupport: false, isSummary: false, index: 48} sunday: {isModifier: false, short: Recurs on Sunday, type: boolean, mustSupport: false, isSummary: false, index: 49} weekInterval: {isModifier: false, short: Recurs every nth week, type: positiveInt, mustSupport: false, isSummary: false, index: 50} occurrenceDate: {isModifier: false, short: Specific dates for a recurring set of appointments (no template), type: date, mustSupport: false, array: true, isSummary: false, index: 41} excludingDate: {isModifier: false, short: Any dates that should be excluded from the series, type: date, mustSupport: false, array: true, isSummary: false, index: 58} occurrenceCount: {isModifier: false, short: The number of planned occurrences, type: positiveInt, mustSupport: false, isSummary: false, index: 40} recurrenceType: isModifier: false short: The frequency of the recurrence type: CodeableConcept mustSupport: false binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/appointment-recurrrence-type'} isSummary: false index: 38 excludingRecurrenceId: {isModifier: false, short: Any recurrence IDs that should be excluded from the recurrence, type: positiveInt, mustSupport: false, array: true, isSummary: false, index: 59} required: [recurrenceType] isSummary: false start: {isModifier: false, short: When appointment is to take place, type: instant, mustSupport: false, isSummary: true, index: 16} created: {isModifier: false, short: The date that this appointment was initially created, type: dateTime, mustSupport: false, isSummary: false, index: 22} participant: constraint: app-1: {human: Either the type or actor on the participant SHALL be specified, source: 'http://hl7.org/fhir/StructureDefinition/Appointment', severity: error, expression: type.exists() or actor.exists()} min: 1 isModifier: false short: Participants involved in appointment index: 28 type: BackboneElement mustSupport: false array: true elements: type: isModifier: false short: Role of participant in the appointment type: CodeableConcept mustSupport: false array: true binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/encounter-participant-type'} isSummary: true index: 29 period: {isModifier: false, short: Participation period of the actor, type: Period, mustSupport: false, isSummary: false, index: 30} actor: isModifier: false short: The individual, device, location, or service participating in the appointment refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Location', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson'] type: Reference mustSupport: false isSummary: true index: 31 required: {isModifier: false, short: The participant is required to attend (optional when false), type: boolean, mustSupport: false, isSummary: true, index: 32} status: isModifier: false short: accepted | declined | tentative | needs-action type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/participationstatus|5.0.0-draft-final'} isSummary: true index: 33 required: [status] isSummary: false serviceType: isModifier: false short: The specific service that is to be performed during this appointment type: CodeableReference mustSupport: false array: true binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/service-type'} isSummary: true index: 5 note: {isModifier: false, short: Additional comments, type: Annotation, mustSupport: false, array: true, isSummary: false, index: 24} account: isModifier: false short: The set of accounts that may be used for billing for this Appointment refers: ['http://hl7.org/fhir/StructureDefinition/Account'] type: Reference mustSupport: false array: true isSummary: false index: 21 virtualService: {isModifier: false, short: Connection details of a virtual service (e.g. conference call), type: VirtualServiceDetail, mustSupport: false, array: true, isSummary: false, index: 12} reason: isModifier: false short: Reason this appointment is scheduled type: CodeableReference mustSupport: false array: true binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/encounter-reason'} isSummary: true index: 8 supportingInformation: isModifier: false short: Additional information to support the appointment refers: ['http://hl7.org/fhir/StructureDefinition/Resource'] type: Reference mustSupport: false array: true isSummary: false index: 13 priority: isModifier: false short: Used to make informed decisions if needing to re-prioritize type: CodeableConcept mustSupport: false binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v3-ActPriority'} isSummary: false index: 9 appointmentType: isModifier: false short: The style of appointment or patient that has been booked in the slot (not service type) type: CodeableConcept mustSupport: false binding: {strength: preferred, valueSet: 'http://terminology.hl7.org/ValueSet/v2-0276'} isSummary: true index: 7 status: isModifier: true short: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist index: 1 type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0-draft-final'} isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid isSummary: true class: isModifier: false short: Classification when becoming an encounter type: CodeableConcept mustSupport: false array: true binding: {strength: preferred, valueSet: 'http://terminology.hl7.org/ValueSet/EncounterClass'} isSummary: true index: 3 minutesDuration: {isModifier: false, short: Can be less than start/end (e.g. estimate), type: positiveInt, mustSupport: false, isSummary: false, index: 18} cancellationReason: isModifier: false short: The coded reason for the appointment being cancelled type: CodeableConcept mustSupport: false binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/appointment-cancellation-reason'} isSummary: true index: 2 identifier: {isModifier: false, short: External Ids for this item, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 0} replaces: isModifier: false short: Appointment replaced by this Appointment refers: ['http://hl7.org/fhir/StructureDefinition/Appointment'] type: Reference mustSupport: false array: true isSummary: false index: 11 basedOn: isModifier: false short: The request this appointment is allocated to assess refers: ['http://hl7.org/fhir/StructureDefinition/CarePlan', 'http://hl7.org/fhir/StructureDefinition/DeviceRequest', 'http://hl7.org/fhir/StructureDefinition/MedicationRequest', 'http://hl7.org/fhir/StructureDefinition/ServiceRequest'] type: Reference mustSupport: false array: true isSummary: false index: 26 end: {isModifier: false, short: When appointment is to conclude, type: instant, mustSupport: false, isSummary: true, index: 17} subject: isModifier: false short: The patient or group associated with the appointment refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Patient'] type: Reference mustSupport: false isSummary: true index: 27 package_version: 5.0.0-draft-final class: resource kind: resource url: http://hl7.org/fhir/StructureDefinition/Appointment base: http://hl7.org/fhir/StructureDefinition/DomainResource version: 5.0.0-draft-final required: [participant, status]