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.r4.examples
derivation: specialization
name: Appointment
type: Appointment
elements:
  description: {type: string, short: 'Shown on a subject line in a meeting request, or appointment list', index: 10}
  serviceCategory:
    short: A broad categorization of the service that is to be performed during this appointment
    type: CodeableConcept
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/service-category'}
    isSummary: true
    index: 3
  slot:
    short: The slots that this appointment is filling
    refers: ['http://hl7.org/fhir/StructureDefinition/Slot']
    type: Reference
    array: true
    index: 15
  specialty:
    short: The specialty of a practitioner that would be required to perform the service requested in this appointment
    type: CodeableConcept
    array: true
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/c80-practice-codes'}
    isSummary: true
    index: 5
  cancelationReason:
    short: The coded reason for the appointment being cancelled
    type: CodeableConcept
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/appointment-cancellation-reason'}
    isSummary: true
    index: 2
  requestedPeriod: {short: Potential date/time interval(s) requested to allocate the appointment within, type: Period, array: true, index: 26}
  patientInstruction: {type: string, short: Detailed information and instructions for the patient, index: 18}
  start: {short: When appointment is to take place, type: instant, isSummary: true, index: 12}
  reasonCode:
    short: Coded reason this appointment is scheduled
    type: CodeableConcept
    array: true
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/encounter-reason'}
    isSummary: true
    index: 7
  created: {short: The date that this appointment was initially created, type: dateTime, index: 16}
  participant:
    constraint:
      app-1: {human: Either the type or actor on the participant SHALL be specified, severity: error, expression: type.exists() or actor.exists()}
    min: 1
    short: Participants involved in appointment
    index: 20
    type: BackboneElement
    array: true
    elements:
      type:
        short: Role of participant in the appointment
        type: CodeableConcept
        array: true
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/encounter-participant-type'}
        isSummary: true
        index: 21
      actor:
        short: Person, Location/HealthcareService or Device
        refers: ['http://hl7.org/fhir/StructureDefinition/Device', '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
        isSummary: true
        index: 22
      required:
        short: required | optional | information-only
        type: code
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/participantrequired|4.0.1'}
        isSummary: true
        index: 23
      status:
        short: accepted | declined | tentative | needs-action
        type: code
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/participationstatus|4.0.1'}
        isSummary: true
        index: 24
      period: {type: Period, short: Participation period of the actor, index: 25}
    required: [status]
  serviceType:
    short: The specific service that is to be performed during this appointment
    type: CodeableConcept
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/service-type'}
    isSummary: true
    index: 4
  supportingInformation:
    short: Additional information to support the appointment
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    array: true
    index: 11
  priority: {short: Used to make informed decisions if needing to re-prioritize, type: unsignedInt, index: 9}
  appointmentType:
    short: The style of appointment or patient that has been booked in the slot (not service type)
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://terminology.hl7.org/ValueSet/v2-0276'}
    isSummary: true
    index: 6
  status:
    isModifier: true
    short: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1'}
    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
  comment: {short: Additional comments, type: string, index: 17}
  minutesDuration: {type: positiveInt, short: Can be less than start/end (e.g. estimate), index: 14}
  identifier: {short: External Ids for this item, type: Identifier, array: true, isSummary: true, index: 0}
  basedOn:
    short: The service request this appointment is allocated to assess
    refers: ['http://hl7.org/fhir/StructureDefinition/ServiceRequest']
    type: Reference
    array: true
    index: 19
  end: {short: When appointment is to conclude, type: instant, isSummary: true, index: 13}
  reasonReference:
    short: Reason the appointment is to take place (resource)
    refers: ['http://hl7.org/fhir/StructureDefinition/Condition', 'http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation', 'http://hl7.org/fhir/StructureDefinition/Observation', 'http://hl7.org/fhir/StructureDefinition/Procedure']
    type: Reference
    array: true
    index: 8
package_version: 4.0.1
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Appointment
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.0.1
required: [participant, status]