NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment TUDomainResourceA 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..*IdentifierExternal Ids for this item

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

... serviceCategory Σ0..*CodeableConceptA 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..*CodeableConceptThe 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..1CodeableConceptThe 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..1CodeableConceptUsed to make informed decisions if needing to re-prioritize
Binding: ActPriority (Example)
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... replaces 0..*Reference(Appointment)Appointment replaced by this Appointment

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

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

... previousAppointment 0..1Reference(Appointment)The previous appointment in a series
... originatingAppointment C0..1Reference(Appointment)The originating appointment in a recurring set of appointments
... start ΣC0..1instantWhen appointment is to take place
... end ΣC0..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... requestedPeriod 0..*PeriodPotential 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..1dateTimeThe date that this appointment was initially created
... cancellationDate C0..1dateTimeWhen the appointment was cancelled
... note 0..*AnnotationAdditional 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..1Reference(Patient | Group)The patient or group associated with the appointment
... participant C1..*BackboneElementParticipants involved in appointment
+ Rule: Either the type or actor on the participant SHALL be specified

.... type ΣC0..*CodeableConceptRole of participant in the appointment
Binding: Participant Type (Extensible)

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

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

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

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


doco Documentation for this format