type: resource-definitionsresource: AppointmentResponse

AppointmentResponse Definitions

AppointmentResponse

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

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

Cardinality: 0..*

Constraints: apr-1 | error | Either the participantType or actor must be specified | participantType.exists() or actor.exists()

Mappings: rim=Act[@moodCode <= 'PRMS']; ical=VEVENT; w5=workflow.scheduling

AppointmentResponse.identifier

External Ids for this item

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.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier; rim=.id; ical=UID

AppointmentResponse.appointment

Appointment this response relates to

Definition: Appointment that this response is replying to.

Cardinality: 1..1

Type: Reference(Appointment)

Summary: true

Mappings: rim=scheduleRequest.ActAppointmentRequest[@moodCode <= 'ARQ']

AppointmentResponse.proposedNewTime

Indicator for a counter proposal

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.

Cardinality: 0..1

Type: boolean

Summary: true

Mappings: rim=n/a; ical=n/a

AppointmentResponse.start

Time from appointment, or requested new start time

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

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.

Cardinality: 0..1

Type: instant

Mappings: w5=FiveWs.init; rim=.effectiveTime.low

AppointmentResponse.end

Time from appointment, or requested new end time

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.

Cardinality: 0..1

Type: instant

Mappings: w5=FiveWs.done[x]; rim=.effectiveTime.high

AppointmentResponse.participantType

Role of participant in the appointment

Definition: Role of participant in the appointment.

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.

Conditions: apr-1

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:encounter-participant-type

Summary: true

Mappings: rim=(performer | reusableDevice | subject | location).@typeCode; ical=n/a

AppointmentResponse.actor

Person(s), Location, HealthcareService, or Device

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

Conditions: apr-1

Cardinality: 0..1

Type: Reference(Patient, Group, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)

Summary: true

Mappings: w5=FiveWs.who; v2=PID-3-Patient ID List; rim=performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation; ical=ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource)

AppointmentResponse.participantStatus

accepted | declined | tentative | needs-action | entered-in-error

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.

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.

Cardinality: 1..1

Type: code

Binding: required:appointmentresponse-status

Summary: true

Is Modifier: true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)

Mappings: rim=(performer | reusableDevice | subject | location).statusCode; ical=ATTENDEE;CN="Brian Postlethwaite";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)

AppointmentResponse.comment

Additional comments

Definition: Additional comments about the appointment.

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

Cardinality: 0..1

Type: markdown

Mappings: rim=.subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value; ical=COMMENT

AppointmentResponse.recurring

This response is for all occurrences in a recurring request

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

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

Cardinality: 0..1

Type: boolean

Mappings: rim=N/A

AppointmentResponse.occurrenceDate

Original date within a recurring request

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

Cardinality: 0..1

Type: date

AppointmentResponse.recurrenceId

The recurrence ID of the specific recurring request

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

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

Cardinality: 0..1

Type: positiveInt