description: Base StructureDefinition for Appointment Resource
package_name: hl7.fhir.core
derivation: specialization
name: Appointment
type: null
elements:
  description: {type: string, short: 'Shown on a subject line in a meeting request, or appointment list', index: 8}
  serviceCategory: {type: CodeableConcept, short: A broad categorisation of the service that is to be performed during this appointment, isSummary: true, index: 2}
  slot: {type: Reference, short: 'If provided, then no schedule and start/end values MUST match slot', array: true, index: 12}
  specialty: {short: The specialty of a practitioner that would be required to perform the service requested in this appointment, type: CodeableConcept, array: true, isSummary: true, index: 4}
  start: {type: instant, short: When appointment is to take place, isSummary: true, index: 9}
  created: {type: dateTime, short: The date that this appointment was initially created, comments: 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., index: 13}
  participant:
    constraint:
      app-1: {human: Either the type or actor on the participant MUST be specified, severity: error, expression: type or actor}
    min: 1
    short: Participants involved in appointment
    index: 15
    type: BackboneElement
    array: true
    elements:
      type:
        short: Role of participant in the appointment
        comments: |-
          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 MUST be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.
        type: CodeableConcept
        array: true
        isSummary: true
        index: 16
      actor: {type: Reference, short: 'Person, Location/HealthcareService or Device', isSummary: true, index: 17}
      required: {short: required | optional | information-only, type: code, isSummary: true, index: 18}
      status: {type: code, short: accepted | declined | tentative | needs-action, index: 19}
    required: [status]
  serviceType: {type: CodeableConcept, short: The specific service that is to be performed during this appointment, isSummary: true, array: true, index: 3}
  reason: {short: Reason this appointment is scheduled, type: CodeableConcept, isSummary: true, index: 6}
  priority:
    type: unsignedInt
    short: Used to make informed decisions if needing to re-prioritize
    comments: |-
      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.
    index: 7
  appointmentType: {short: The style of appointment or patient that has been booked in the slot (not service type), type: CodeableConcept, isSummary: true, index: 5}
  status: {isModifier: true, short: proposed | pending | booked | arrived | fulfilled | cancelled | noshow, comments: 'If the Appointment''s status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.', type: code, isSummary: true, index: 1}
  comment:
    type: string
    short: Additional comments
    comments: |-
      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.
    index: 14
  minutesDuration: {type: positiveInt, short: Can be less than start/end (e.g. estimate), index: 11}
  identifier: {type: Identifier, short: External Ids for this item, isSummary: true, array: true, index: 0}
  end: {type: instant, short: When appointment is to conclude, isSummary: true, index: 10}
package_version: 1.4.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Appointment
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [participant, status]