DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

5.27.8 Resource Appointment - Detailed Descriptions

Detailed Descriptions for the elements in the Appointment resource.

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

Control1..1
InvariantsDefined on this element
app-2: Either start and end are specified, or neither (xpath: ((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end)))))
app-3: Only proposed or cancelled appointments can be missing start/end dates (xpath: ((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled')))
Appointment.identifier
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).

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Appointment.status
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.

Control1..1
BindingAppointmentStatus: The free/busy status of an appointment. (Required)
Typecode
Is Modifiertrue
Summarytrue
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.

Appointment.type
Definition

The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService).

Control0..1
BindingPractice Setting Code Value Set: Additional details about where the content was created (e.g. clinical specialty). (Preferred)
TypeCodeableConcept
Summarytrue
Appointment.reason
Definition

The reason that this appointment is being scheduled. This is more clinical than administrative.

Control0..1
BindingEncounter Reason Codes: The Reason for the appointment to take place. (Required)
TypeCodeableConcept
Summarytrue
Appointment.priority
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).

Control0..1
TypeunsignedInt
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.

Appointment.description
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 comment field.

Control0..1
Typestring
Appointment.start
Definition

Date/Time that the appointment is to take place.

Control0..1
Typeinstant
Summarytrue
Appointment.end
Definition

Date/Time that the appointment is to conclude.

Control0..1
Typeinstant
Summarytrue
Appointment.minutesDuration
Definition

Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).

Control0..1
TypepositiveInt
Appointment.slot
Definition

The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.

Control0..*
TypeReference(Slot)
Appointment.comment
Definition

Additional comments about the appointment.

Control0..1
Typestring
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.

Appointment.participant
Definition

List of participants involved in the appointment.

Control1..*
InvariantsDefined on this element
app-1: Either the type or actor on the participant MUST be specified (xpath: (exists(f:type) or exists(f:actor)))
Appointment.participant.type
Definition

Role of participant in the appointment.

Control0..*
BindingParticipantType: Role of participant in encounter. (Required)
TypeCodeableConcept
Summarytrue
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.

Appointment.participant.actor
Definition

A Person, Location/HealthcareService or Device that is participating in the appointment.

Control0..1
TypeReference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location)
Summarytrue
Appointment.participant.required
Definition

Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.

Control0..1
BindingParticipantRequired: Is the Participant required to attend the appointment. (Required)
Typecode
Summarytrue
Appointment.participant.status
Definition

Participation status of the Patient.

Control1..1
BindingParticipationStatus: The Participation status of an appointment. (Required)
Typecode