Data Model Libraries
    Preparing search index...

    Appointment Class

    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).

    FHIR Specification

    • Short: 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)
    • Definition: 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).
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getCancellationReason setCancellationReason hasCancellationReason getClass setClass addClass hasClass getServiceCategory setServiceCategory addServiceCategory hasServiceCategory getServiceType setServiceType addServiceType hasServiceType getSpecialty setSpecialty addSpecialty hasSpecialty getAppointmentType setAppointmentType hasAppointmentType getReason setReason addReason hasReason getPriority setPriority hasPriority getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getReplaces setReplaces addReplaces hasReplaces getVirtualService setVirtualService addVirtualService hasVirtualService getSupportingInformation setSupportingInformation addSupportingInformation hasSupportingInformation getPreviousAppointment setPreviousAppointment hasPreviousAppointment getOriginatingAppointment setOriginatingAppointment hasOriginatingAppointment getStartElement setStartElement hasStartElement getStart setStart hasStart getEndElement setEndElement hasEndElement getEnd setEnd hasEnd getMinutesDurationElement setMinutesDurationElement hasMinutesDurationElement getMinutesDuration setMinutesDuration hasMinutesDuration getRequestedPeriod setRequestedPeriod addRequestedPeriod hasRequestedPeriod getSlot setSlot addSlot hasSlot getAccount setAccount addAccount hasAccount getCreatedElement setCreatedElement hasCreatedElement getCreated setCreated hasCreated getCancellationDateElement setCancellationDateElement hasCancellationDateElement getCancellationDate setCancellationDate hasCancellationDate getNote setNote addNote hasNote getPatientInstruction setPatientInstruction addPatientInstruction hasPatientInstruction getBasedOn setBasedOn addBasedOn hasBasedOn getSubject setSubject hasSubject getParticipant setParticipant addParticipant hasParticipant getRecurrenceIdElement setRecurrenceIdElement hasRecurrenceIdElement getRecurrenceId setRecurrenceId hasRecurrenceId getOccurrenceChangedElement setOccurrenceChangedElement hasOccurrenceChangedElement getOccurrenceChanged setOccurrenceChanged hasOccurrenceChanged getRecurrenceTemplate setRecurrenceTemplate addRecurrenceTemplate hasRecurrenceTemplate fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initClass initServiceCategory initServiceType initSpecialty initReason initReplaces initVirtualService initSupportingInformation initRequestedPeriod initSlot initAccount initNote initPatientInstruction initBasedOn initParticipant initRecurrenceTemplate

    Constructors

    Properties

    identifier?: Identifier[]

    Appointment.identifier Element

    FHIR Specification

    • Short: External Ids for this item
    • Definition: This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    appointmentstatusEnum: AppointmentstatusEnum

    FHIR CodeSystem: Appointmentstatus

    status: null | EnumCodeType

    Appointment.status Element

    FHIR Specification

    • Short: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
    • Definition: The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
    • Comment: 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. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • 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

    CodeSystem Enumeration: AppointmentstatusEnum

    cancellationReason?: CodeableConcept

    Appointment.cancellationReason Element

    FHIR Specification

    • Short: The coded reason for the appointment being cancelled
    • Definition: The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    class_?: CodeableConcept[]

    Appointment.class Element

    FHIR Specification

    • Short: Classification when becoming an encounter
    • Definition: Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    serviceCategory?: CodeableConcept[]

    Appointment.serviceCategory Element

    FHIR Specification

    • Short: A broad categorization of the service that is to be performed during this appointment
    • Definition: A broad categorization of the service that is to be performed during this appointment.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    serviceType?: CodeableReference[]

    Appointment.serviceType Element

    FHIR Specification

    • Short: The specific service that is to be performed during this appointment
    • Definition: The specific service that is to be performed during this appointment.
    • Comment: For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.
    • FHIR Type: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    specialty?: CodeableConcept[]

    Appointment.specialty Element

    FHIR Specification

    • Short: The specialty of a practitioner that would be required to perform the service requested in this appointment
    • Definition: The specialty of a practitioner that would be required to perform the service requested in this appointment.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    appointmentType?: CodeableConcept

    Appointment.appointmentType Element

    FHIR Specification

    • Short: The style of appointment or patient that has been booked in the slot (not service type)
    • Definition: The style of appointment or patient that has been booked in the slot (not service type).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Appointment.reason Element

    FHIR Specification

    priority?: CodeableConcept

    Appointment.priority Element

    FHIR Specification

    • Short: Used to make informed decisions if needing to re-prioritize
    • Definition: The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
    • Comment: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: StringType

    Appointment.description Element

    FHIR Specification

    • Short: Shown on a subject line in a meeting request, or appointment list
    • Definition: The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the note field.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    replaces?: Reference[]

    Appointment.replaces Element

    FHIR Specification

    • Short: Appointment replaced by this Appointment
    • Definition: Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    virtualService?: VirtualServiceDetail[]

    Appointment.virtualService Element

    FHIR Specification

    • Short: Connection details of a virtual service (e.g. conference call)
    • Definition: Connection details of a virtual service (e.g. conference call).
    • Comment: There are two types of virtual meetings that often exist: * a persistent, virtual meeting room that can only be used for a single purpose at a time, * and a dynamic virtual meeting room that is generated on demand for a specific purpose. Implementers may consider using Location.virtualService for persistent meeting rooms. If each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Appointment.participant BackboneElement.
    • FHIR Type: VirtualServiceDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    supportingInformation?: Reference[]

    Appointment.supportingInformation Element

    FHIR Specification

    • Short: Additional information to support the appointment
    • Definition: Additional information to support the appointment provided when making the appointment.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    previousAppointment?: Reference

    Appointment.previousAppointment Element

    FHIR Specification

    • Short: The previous appointment in a series
    • Definition: The previous appointment in a series of related appointments.
    • Comment: This property is intended for use when representing a series of related appointments. For example, in a nuclear medicine procedure, where there is an appointment for the injection of the isotopes, and then a subsequent appointment for the scan, the scan appointment would refer to the injection appointment via Appointment.previousAppointment. For representing recurring appointments, see the guidance on recurring vs. series appointments.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    originatingAppointment?: Reference

    Appointment.originatingAppointment Element

    FHIR Specification

    • Short: The originating appointment in a recurring set of appointments
    • Definition: The originating appointment in a recurring set of related appointments.
    • Comment: This property is intended for use when representing a recurring set of related appointments. For example, a patient undergoing physical therapy may have a recurring appointment every Tuesday and Thursday. Each occurrence of the set will refer to the originating appointment, which contains the recurring template information. For representing appointment series, see the guidance on recurring vs. series appointments.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    start?: InstantType

    Appointment.start Element

    FHIR Specification

    • Short: When appointment is to take place
    • Definition: Date/Time that the appointment is to take place.
    • Comment: If actual start/end times are not known then the requested period start/end can be used.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Appointment.end Element

    FHIR Specification

    • Short: When appointment is to conclude
    • Definition: Date/Time that the appointment is to conclude.
    • Comment: If actual start/end times are not known then the requested period start/end can be used.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    minutesDuration?: PositiveIntType

    Appointment.minutesDuration Element

    FHIR Specification

    • Short: Can be less than start/end (e.g. estimate)
    • Definition: Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    requestedPeriod?: Period[]

    Appointment.requestedPeriod Element

    FHIR Specification

    • Short: Potential date/time interval(s) requested to allocate the appointment within
    • Definition: A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.
    • Comment: This does not introduce a capacity for recurring appointments.
    • FHIR Type: Period
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    slot?: Reference[]

    Appointment.slot Element

    FHIR Specification

    • Short: The slots that this appointment is filling
    • Definition: The slots from the participants' schedules that will be filled by the appointment.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    account?: Reference[]

    Appointment.account Element

    FHIR Specification

    • Short: The set of accounts that may be used for billing for this Appointment
    • Definition: The set of accounts that is expected to be used for billing the activities that result from this Appointment.
    • Comment: The specified account(s) could be those identified during pre-registration workflows in preparation for an upcoming Encounter.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    created?: DateTimeType

    Appointment.created Element

    FHIR Specification

    • Short: The date that this appointment was initially created
    • Definition: The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
    • Comment: 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.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    cancellationDate?: DateTimeType

    Appointment.cancellationDate Element

    FHIR Specification

    • Short: When the appointment was cancelled
    • Definition: The date/time describing when the appointment was cancelled.
    • Comment: If the appointment was cancelled multiple times, this would reflect the most recent cancellation.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    Appointment.note Element

    FHIR Specification

    • Short: Additional comments
    • Definition: Additional notes/comments about the appointment.
    • Comment: Additional text to aid in facilitating the appointment. For instance, a note 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. Typically only the concept.text will be used, however occasionally a reference to some generic documentation (or specific) and also supports coded instructions if/when they are required.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    patientInstruction?: CodeableReference[]

    Appointment.patientInstruction Element

    FHIR Specification

    basedOn?: Reference[]

    Appointment.basedOn Element

    FHIR Specification

    subject?: Reference

    Appointment.subject Element

    FHIR Specification

    participant: null | AppointmentParticipantComponent[]

    Appointment.participant Element

    FHIR Specification

    • Short: Participants involved in appointment
    • Definition: List of participants involved in the appointment.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false
    recurrenceId?: PositiveIntType

    Appointment.recurrenceId Element

    FHIR Specification

    • Short: The sequence number in the recurrence
    • Definition: The sequence number that identifies a specific appointment in a recurring pattern.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    occurrenceChanged?: BooleanType

    Appointment.occurrenceChanged Element

    FHIR Specification

    • Short: Indicates that this appointment varies from a recurrence pattern
    • Definition: This appointment varies from the recurring pattern.
    • Comment: For example, if a patient has physical therapy appointments every Tuesday and Thursday, but due to a national holiday, a single occurrence was rescheduled to a different day, while the rest of the recurring series remained on Tuesday / Thursday.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Appointment.recurrenceTemplate Element

    FHIR Specification

    • Short: Details of the recurrence pattern/template used to generate occurrences
    • Definition: The details of the recurrence pattern or template that is used to generate recurring appointments.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Appointment JSON to instantiate the Appointment data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Appointment

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Appointment

      Returns undefined | Appointment

      Appointment data model or undefined for Appointment

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided PreviousAppointment object value to the previousAppointment property.

      Parameters

      • value: undefined | Reference

        the previousAppointment object value

      Returns this

      this

      @ReferenceTargets('Appointment.previousAppointment', ['Appointment',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided OriginatingAppointment object value to the originatingAppointment property.

      Parameters

      • value: undefined | Reference

        the originatingAppointment object value

      Returns this

      this

      @ReferenceTargets('Appointment.originatingAppointment', ['Appointment',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise