FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Patient Administration icon Work GroupMaturity Level: 3 Trial UseSecurity Category: Patient Compartments: Device, Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the AppointmentResponse resource.

AppointmentResponse
Element IdAppointmentResponse
Definition

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

Short DisplayA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
Cardinality0..*
TypeDomainResource
Summaryfalse
Invariants
Defined on this element
apr-1Rule Either the participantType or actor must be specifiedparticipantType.exists() or actor.exists()
AppointmentResponse.identifier
Element IdAppointmentResponse.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.

Short DisplayExternal Ids for this item
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
AppointmentResponse.appointment
Element IdAppointmentResponse.appointment
Definition

Appointment that this response is replying to.

Short DisplayAppointment this response relates to
Cardinality1..1
TypeReference(Appointment)
Summarytrue
AppointmentResponse.proposedNewTime
Element IdAppointmentResponse.proposedNewTime
Definition

Indicates that the response is proposing a different time that was initially requested. The new proposed time will be indicated in the start and end properties.

Short DisplayIndicator for a counter proposal
Cardinality0..1
Typeboolean
Summarytrue
AppointmentResponse.start
Element IdAppointmentResponse.start
Definition

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

Short DisplayTime from appointment, or requested new start time
Cardinality0..1
Typeinstant
Summaryfalse
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
Element IdAppointmentResponse.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.

Short DisplayTime from appointment, or requested new end time
Cardinality0..1
Typeinstant
Summaryfalse
AppointmentResponse.participantType
Element IdAppointmentResponse.participantType
Definition

Role of participant in the appointment.

Short DisplayRole of participant in the appointment
Cardinality0..*
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 SHALL be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated.

AppointmentResponse.actor
Element IdAppointmentResponse.actor
Definition

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

Short DisplayPerson(s), Location, HealthcareService, or Device
Cardinality0..1
TypeReference(Patient | Group | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)
Summarytrue
AppointmentResponse.participantStatus
Element IdAppointmentResponse.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.

Short Displayaccepted | declined | tentative | needs-action
Cardinality1..1
Terminology BindingParticipationStatus (Required)
Typecode
Is Modifiertrue (Reason: Not known why this is labelled a modifier)
Summarytrue
Comments

This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid.

AppointmentResponse.comment
Element IdAppointmentResponse.comment
Definition

Additional comments about the appointment.

Short DisplayAdditional comments
Cardinality0..1
Typestring
Summaryfalse
Comments

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

AppointmentResponse.recurring
Element IdAppointmentResponse.recurring
Definition

Indicates that this AppointmentResponse applies to all occurrences in a recurring request.

Short DisplayThis response is for all occurrences in a recurring request
Cardinality0..1
Typeboolean
Summaryfalse
Comments

When a recurring appointment is requested, the participant may choose to respond to each individual occurrence, in which case AppointmentResponse.recurring should be false. If the participant chooses to respond the same way for all occurrences, they may instead use a single AppointmentResponse with recurring set to true. These may be combined as the participant chooses. For example, they may accept all occurrences (recurring = true), but then send a decline for a specific occurrence (recurring=false).

AppointmentResponse.occurrenceDate
Element IdAppointmentResponse.occurrenceDate
Definition

The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in Appointment.occurrenceDate).

Short DisplayOriginal date within a recurring request
Cardinality0..1
Typedate
Summaryfalse
AppointmentResponse.recurrenceId
Element IdAppointmentResponse.recurrenceId
Definition

The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.

Short DisplayThe recurrence ID of the specific recurring request
Cardinality0..1
TypepositiveInt
Summaryfalse
Comments

If the recurrence template was defined using the list of occurrenceDates then this property might not be used.