DSTU2

This page is part of the FHIR Specification (v0.0.82: (v1.0.2: DSTU 1). 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.26.7 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).

Control 1..1
Invariants Defined 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 processed and/ or 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).

Note This is a business identifer, not a resource identifier (see discussion )
Control 0..*
Type Identifier
Summary true
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.

Control 1..1
Binding AppointmentStatus: Required : http://hl7.org/fhir/appointmentstatus (The The free/busy status of an appointment) appointment. ( Required )
Type code
Is Modifier true
Summary true
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 Slot's 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).

Control 0..1
Binding DocumentC80PracticeSetting: Preferred : Practice Setting Code Value Set: See http://hl7.org/fhir/vs/c80-practice-codes (Additional Additional details about where the content was created (e.g. clinical specialty)) specialty). ( Preferred )
Type CodeableConcept
Summary true
Appointment.reason
Definition

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

Control 0..1
Binding ApptReason: Required : Encounter Reason Codes: See http://hl7.org/fhir/vs/encounter-reason (The The Reason for the appointment to take place) place. ( Required )
Type CodeableConcept
Summary true
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).

Control 0..1
Type integer unsignedInt
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.

Control 0..1
Type string
Appointment.start
Definition

Date/Time that the appointment is to take place.

Control 1..1 0..1
Type instant
Summary true
Appointment.end
Definition

Date/Time that the appointment is to conclude.

Control 1..1 0..1
Type instant
Summary true
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).

Control 0..1
Type positiveInt
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.

Control 0..*
Type Reference ( Slot )
Appointment.comment
Definition

Additional comments about the appointment.

Control 0..1
Type string
Comments

Additional text to aid in facilitating the appointment. For instance, a comment might be, “patient "patient should proceed immediately to infusion room upon arrival”. 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.order Appointment.participant
Definition

An Order that lead to the creation List of this participants involved in the appointment.

Control 0..1 1..*
Type Invariants Reference ( Order ) Appointment.participant Defined on this element Definition List of participants involved in
app-1 : Either the appointment. Control 1..* 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.

Control 0..*
Binding ParticipantType: Required : See http://hl7.org/fhir/vs/encounter-participant-type (Role Role of participant in encounter) encounter. ( Required )
Type CodeableConcept
Summary true
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.

Control 0..1
Type Reference ( Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location )
Summary true
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.

Control 0..1
Binding ParticipantRequired: Required : http://hl7.org/fhir/participantrequired (Is Is the Participant required to attend the appointment) appointment. ( Required )
Type code
Summary true
Appointment.participant.status
Definition

Participation status of the Patient.

Control 1..1
Binding ParticipationStatus: Required : http://hl7.org/fhir/participationstatus (The The Participation status of an appointment) appointment. ( Required )
Type code