http://hl7.org/fhir/StructureDefinition/Appointment|5.0.0

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).
derivation: specialization
name: Appointment
type: Appointment
elements:
  description: {isModifier: false, short: 'Shown on a subject line in a meeting request, or appointment list', mustSupport: false, isSummary: false, index: 10}
  serviceCategory:
    isModifier: false
    short: A broad categorization of the service that is to be performed during this appointment
    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, mustSupport: false, array: true, isSummary: false, index: 20}
  previousAppointment: {isModifier: false, short: The previous appointment in a series, mustSupport: false, isSummary: false, index: 14}
  originatingAppointment: {isModifier: false, short: The originating appointment in a recurring set of appointments, mustSupport: false, isSummary: false, index: 15}
  recurrenceId: {isModifier: false, short: The sequence number in the recurrence, mustSupport: false, isSummary: false, index: 34}
  cancellationDate: {isModifier: false, short: When the appointment was cancelled, 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
    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, mustSupport: false, isSummary: false, index: 35}
  requestedPeriod: {isModifier: false, short: Potential date/time interval(s) requested to allocate the appointment within, mustSupport: false, array: true, isSummary: false, index: 19}
  patientInstruction: {isModifier: false, short: Detailed information and instructions for the patient, mustSupport: false, array: true, isSummary: false, index: 25}
  recurrenceTemplate:
    isModifier: false
    short: Details of the recurrence pattern/template used to generate occurrences
    mustSupport: false
    array: true
    isSummary: false
    index: 36
    elements:
      timezone:
        isModifier: false
        short: The timezone of the occurrences
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/timezones|5.0.0'}
        isSummary: false
        index: 37
      lastOccurrenceDate: {isModifier: false, short: The date when the recurrence should end, mustSupport: false, isSummary: false, index: 39}
      yearlyTemplate:
        isModifier: false
        short: Information about yearly recurring appointments
        mustSupport: false
        isSummary: false
        index: 56
        elements:
          yearInterval: {isModifier: false, short: Recurs every nth year, mustSupport: false, isSummary: false, index: 57}
        required: [yearInterval]
      monthlyTemplate:
        isModifier: false
        short: Information about monthly recurring appointments
        mustSupport: false
        isSummary: false
        index: 51
        elements:
          dayOfMonth: {isModifier: false, short: Recurs on a specific day of the month, mustSupport: false, isSummary: false, index: 52}
          nthWeekOfMonth:
            isModifier: false
            short: Indicates which week of the month the appointment should occur
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/week-of-month|5.0.0'}
            isSummary: false
            index: 53
          dayOfWeek:
            isModifier: false
            short: Indicates which day of the week the appointment should occur
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/days-of-week|5.0.0'}
            isSummary: false
            index: 54
          monthInterval: {isModifier: false, short: Recurs every nth month, mustSupport: false, isSummary: false, index: 55}
        required: [monthInterval]
      weeklyTemplate:
        isModifier: false
        short: Information about weekly recurring appointments
        mustSupport: false
        isSummary: false
        index: 42
        elements:
          monday: {isModifier: false, short: Recurs on Mondays, mustSupport: false, isSummary: false, index: 43}
          tuesday: {isModifier: false, short: Recurs on Tuesday, mustSupport: false, isSummary: false, index: 44}
          wednesday: {isModifier: false, short: Recurs on Wednesday, mustSupport: false, isSummary: false, index: 45}
          thursday: {isModifier: false, short: Recurs on Thursday, mustSupport: false, isSummary: false, index: 46}
          friday: {isModifier: false, short: Recurs on Friday, mustSupport: false, isSummary: false, index: 47}
          saturday: {isModifier: false, short: Recurs on Saturday, mustSupport: false, isSummary: false, index: 48}
          sunday: {isModifier: false, short: Recurs on Sunday, mustSupport: false, isSummary: false, index: 49}
          weekInterval: {isModifier: false, short: Recurs every nth week, mustSupport: false, isSummary: false, index: 50}
      occurrenceDate: {isModifier: false, short: Specific dates for a recurring set of appointments (no template), mustSupport: false, array: true, isSummary: false, index: 41}
      excludingDate: {isModifier: false, short: Any dates that should be excluded from the series, mustSupport: false, array: true, isSummary: false, index: 58}
      occurrenceCount: {isModifier: false, short: The number of planned occurrences, mustSupport: false, isSummary: false, index: 40}
      recurrenceType:
        isModifier: false
        short: The frequency of the recurrence
        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, mustSupport: false, array: true, isSummary: false, index: 59}
    required: [recurrenceType]
  start: {isModifier: false, short: When appointment is to take place, mustSupport: false, isSummary: true, index: 16}
  created: {isModifier: false, short: The date that this appointment was initially created, 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
    mustSupport: false
    array: true
    elements:
      type:
        isModifier: false
        short: Role of participant in the appointment
        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, mustSupport: false, isSummary: false, index: 30}
      actor: {isModifier: false, short: 'The individual, device, location, or service participating in the appointment', mustSupport: false, isSummary: true, index: 31}
      required: {isModifier: false, short: The participant is required to attend (optional when false), mustSupport: false, isSummary: true, index: 32}
      status:
        isModifier: false
        short: accepted | declined | tentative | needs-action
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/participationstatus|5.0.0'}
        isSummary: true
        index: 33
    required: [status]
    isSummary: false
  serviceType:
    isModifier: false
    short: The specific service that is to be performed during this appointment
    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, 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, mustSupport: false, array: true, isSummary: false, index: 21}
  virtualService: {isModifier: false, short: Connection details of a virtual service (e.g. conference call), mustSupport: false, array: true, isSummary: false, index: 12}
  reason:
    isModifier: false
    short: Reason this appointment is scheduled
    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, mustSupport: false, array: true, isSummary: false, index: 13}
  priority:
    isModifier: false
    short: Used to make informed decisions if needing to re-prioritize
    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)
    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
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0'}
    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
    index: 1
  class:
    isModifier: false
    short: Classification when becoming an encounter
    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), mustSupport: false, isSummary: false, index: 18}
  cancellationReason:
    isModifier: false
    short: The coded reason for the appointment being cancelled
    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, mustSupport: false, array: true, isSummary: true, index: 0}
  replaces: {isModifier: false, short: Appointment replaced by this Appointment, mustSupport: false, array: true, isSummary: false, index: 11}
  basedOn: {isModifier: false, short: The request this appointment is allocated to assess, mustSupport: false, array: true, isSummary: false, index: 26}
  end: {isModifier: false, short: When appointment is to conclude, mustSupport: false, isSummary: true, index: 17}
  subject: {isModifier: false, short: The patient or group associated with the appointment, mustSupport: false, isSummary: true, index: 27}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Appointment
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [participant, status]