Name Flags Card. Type Description & Constraints doco
. . Appointment TU DomainResource 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)
+ Rule: Either start and end are specified, or neither
+ Rule: Only proposed or cancelled appointments can be missing start/end dates
+ Rule: Cancellation reason is only used for appointments that have been cancelled, or noshow
+ Rule: The start must be less than or equal to the end
+ Guideline: An appointment may have an originatingAppointment or recurrenceTemplate, but not both
+ Rule: Cancellation date is only used for appointments that have been cancelled, or noshow

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Ids for this item

. . . status ?! Σ C 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: Appointment Status ( Required)
. . . cancellationReason Σ C 0..1 CodeableConcept The coded reason for the appointment being cancelled
Binding: Appointment Cancellation Reason ( Example)
. . . class Σ 0..* CodeableConcept Classification when becoming an encounter
Binding: EncounterClass ( Preferred)

. . . serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: Service Category ( Example)

. . . serviceType Σ 0..* CodeableReference( HealthcareService) The specific service that is to be performed during this appointment
Binding: Service Type ( Example)

. . . specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set ( Preferred)

. . . appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes ( Preferred)
. . . reason Σ 0..* CodeableReference( Condition | Procedure | Observation | ImmunizationRecommendation) Reason this appointment is scheduled
Binding: Encounter Reason Codes ( Preferred)

. . . priority 0..1 CodeableConcept Used to make informed decisions if needing to re-prioritize
Binding: ActPriority ( Example)
. . . description 0..1 string Shown on a subject line in a meeting request, or appointment list
. . . replaces 0..* Reference( Appointment) Appointment replaced by this Appointment

. . . virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)

. . . supportingInformation 0..* Reference( Any) Additional information to support the appointment

. . . previousAppointment 0..1 Reference( Appointment) The previous appointment in a series
. . . originatingAppointment C 0..1 Reference( Appointment) The originating appointment in a recurring set of appointments
. . . start Σ C 0..1 instant When appointment is to take place
. . . end Σ C 0..1 instant When appointment is to conclude
. . . minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
. . . requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

. . . slot 0..* Reference( Slot) The slots that this appointment is filling

. . . account 0..* Reference( Account) The set of accounts that may be used for billing for this Appointment

. . . created 0..1 dateTime The date that this appointment was initially created
. . . cancellationDate C 0..1 dateTime When the appointment was cancelled
. . . note 0..* Annotation Additional comments

. . . patientInstruction 0..* CodeableReference( DocumentReference | Binary | Communication) Detailed information and instructions for the patient

. . . basedOn 0..* Reference( CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) The request this appointment is allocated to assess

. . . subject Σ 0..1 Reference( Patient | Group) The patient or group associated with the appointment
. . . participant C 1..* BackboneElement Participants involved in appointment
+ Rule: Either the type or actor on the participant SHALL be specified

. . . . type Σ C 0..* CodeableConcept Role of participant in the appointment
Binding: Participant Type ( Extensible)

. . . . period 0..1 Period Participation period of the actor
. . . . actor Σ C 0..1 Reference( Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) The individual, device, location, or service participating in the appointment
. . . . required Σ 0..1 boolean The participant is required to attend (optional when false)
. . . . status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: Participation Status ( Required)
. . . recurrenceId 0..1 positiveInt The sequence number in the recurrence
. . . occurrenceChanged 0..1 boolean Indicates that this appointment varies from a recurrence pattern
. . . recurrenceTemplate C 0..* BackboneElement Details of the recurrence pattern/template used to generate occurrences

. . . . timezone 0..1 CodeableConcept The timezone of the occurrences
Binding: IANA Timezones ( Required)
. . . . recurrenceType 1..1 CodeableConcept The frequency of the recurrence
Binding: Appointment Recurrence Type ( Preferred)
. . . . lastOccurrenceDate 0..1 date The date when the recurrence should end
. . . . occurrenceCount 0..1 positiveInt The number of planned occurrences
. . . . occurrenceDate 0..* date Specific dates for a recurring set of appointments (no template)

. . . . weeklyTemplate 0..1 BackboneElement Information about weekly recurring appointments
. . . . . monday 0..1 boolean Recurs on Mondays
. . . . . tuesday 0..1 boolean Recurs on Tuesday
. . . . . wednesday 0..1 boolean Recurs on Wednesday
. . . . . thursday 0..1 boolean Recurs on Thursday
. . . . . friday 0..1 boolean Recurs on Friday
. . . . . saturday 0..1 boolean Recurs on Saturday
. . . . . sunday 0..1 boolean Recurs on Sunday
. . . . . weekInterval 0..1 positiveInt Recurs every nth week
. . . . monthlyTemplate 0..1 BackboneElement Information about monthly recurring appointments
. . . . . dayOfMonth 0..1 positiveInt Recurs on a specific day of the month
. . . . . nthWeekOfMonth 0..1 Coding Indicates which week of the month the appointment should occur
Binding: Week Of Month ( Required)
. . . . . dayOfWeek 0..1 Coding Indicates which day of the week the appointment should occur
Binding: Days Of Week ( Required)
. . . . . monthInterval 1..1 positiveInt Recurs every nth month
. . . . yearlyTemplate 0..1 BackboneElement Information about yearly recurring appointments
. . . . . yearInterval 1..1 positiveInt Recurs every nth year
. . . . excludingDate 0..* date Any dates that should be excluded from the series

. . . . excludingRecurrenceId 0..* positiveInt Any recurrence IDs that should be excluded from the recurrence


doco Documentation for this format