STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

Detailed Descriptions for the elements in the AppointmentResponse resource.

AppointmentResponse
Definition

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

Control1..1
InvariantsDefined on this element
apr-1: Either the participantType or actor must be specified (expression : participantType.exists() or actor.exists(), xpath: (exists(f:participantType) or exists(f:actor)))
AppointmentResponse.identifier
Definition

This records identifiers associated with this appointment response 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.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
AppointmentResponse.appointment
Definition

Appointment that this response is replying to.

Control1..1
TypeReference(Appointment)
Summarytrue
AppointmentResponse.start
Definition

Date/Time that the appointment is to take place, or requested new start time.

Control0..1
Typeinstant
Comments

This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the start time.

AppointmentResponse.end
Definition

This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.

Control0..1
Typeinstant
AppointmentResponse.participantType
Definition

Role of participant in the appointment.

Control0..*
Terminology BindingParticipantType (Extensible)
TypeCodeableConcept
Summarytrue
Comments

The role of the participant can be used to declare what the actor will be doing in the scope of the referenced 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 as specified on the referenced Appointment so that they can be matched, and subsequently updated.

AppointmentResponse.actor
Definition

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

Control0..1
TypeReference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location)
Summarytrue
AppointmentResponse.participantStatus
Definition

Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.

Control1..1
Terminology BindingParticipationStatus (Required)
Typecode
Is Modifiertrue
Summarytrue
AppointmentResponse.comment
Definition

Additional comments about the appointment.

Control0..1
Typestring
Comments

This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.