DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 3). 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 R3 R2

Patient Administration Work Group Maturity Level : 3   Trial Use Compartments : Device , Patient , Practitioner , RelatedPerson

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: ( expression : start.empty() xor end.exists(), 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: ( expression : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled')), 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).

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
Terminology Binding AppointmentStatus: The free/busy status of an appointment. AppointmentStatus ( 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 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.

Appointment.type Appointment.serviceCategory
Definition

The type A broad categorisation of appointment the service that is being booked (This may also to be associated with participants for location, and/or a HealthcareService). performed during this appointment.

Control 0..1
Terminology Binding ServiceCategory ( Example )
Type CodeableConcept
Summary true
Appointment.serviceType
Definition

The specific service that is to be performed during this appointment.

Control 0..*
Terminology Binding ServiceType ( Example )
Type CodeableConcept
Summary true
Appointment.specialty
Definition

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Control 0..*
Terminology Binding Practice Setting Code Value Set: Additional details about where Set ( Preferred )
Type CodeableConcept
Summary true
Appointment.appointmentType
Definition

The style of appointment or patient that has been booked in the content was created (e.g. clinical specialty). slot (not service type).

Control 0..1
Terminology Binding v2 Appointment reason codes ( Preferred )
Type CodeableConcept
Summary true
Appointment.reason
Definition

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

Control 0..1 0..*
Terminology Binding Encounter Reason Codes: The Encounter Reason for the appointment to take place. Codes ( Required Preferred )
Type CodeableConcept
Summary true
Appointment.indication
Definition

Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

Control 0..*
Type Reference ( Condition | Procedure )
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 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.supportingInformation
Definition

Additional information to support the appointment provided when making the appointment.

Control 0..*
Type Reference ( Any )
Appointment.start
Definition

Date/Time that the appointment is to take place.

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

Date/Time that the appointment is to conclude.

Control 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 from the start/end values MUST participants' schedules that will be filled by the same as from the slot. appointment.

Control 0..*
Type Reference ( Slot )
Appointment.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.

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

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 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.incomingReferral
Definition

The referral request this appointment is allocated to assess (incoming referral).

Control 0..*
Type Reference ( ReferralRequest )
Appointment.participant
Definition

List of participants involved in the appointment.

Control 1..*
Invariants Defined on this element
app-1 : Either the type or actor on the participant MUST SHALL be specified (xpath: ( expression : type.exists() or actor.exists(), xpath: (exists(f:type) or exists(f:actor)))
Appointment.participant.type
Definition

Role of participant in the appointment.

Control 0..*
Terminology Binding ParticipantType: Role of participant in encounter. ParticipantType ( Required Extensible )
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 SHALL 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
Terminology Binding ParticipantRequired: Is the Participant required to attend the appointment. ParticipantRequired ( Required )
Type code
Summary true
Appointment.participant.status
Definition

Participation status of the Patient. actor.

Control 1..1
Terminology Binding ParticipationStatus: The Participation status of an appointment. ParticipationStatus ( Required )
Type code
Appointment.requestedPeriod
Definition

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.

Control 0..*
Type Period
Comments

This does not introduce a capacity for recurring appointments.