Release 5
WorkflowThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| Patient Administration Work Group | Maturity Level: 3 | Trial Use | Security Category: Patient | Compartments: Device, Patient, Practitioner, RelatedPerson |
Detailed Descriptions for the elements in the AppointmentResponse resource.
| AppointmentResponse | |||||||||
| Element Id | AppointmentResponse | ||||||||
| Definition | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. | ||||||||
| Short Display | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection | ||||||||
| Cardinality | 0..* | ||||||||
| Type | DomainResource | ||||||||
| Summary | false | ||||||||
| Invariants |
| ||||||||
| AppointmentResponse.identifier | |||||||||
| Element Id | 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. | ||||||||
| Short Display | External Ids for this item | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Identifier | ||||||||
| Summary | true | ||||||||
| AppointmentResponse.appointment | |||||||||
| Element Id | AppointmentResponse.appointment | ||||||||
| Definition | Appointment that this response is replying to. | ||||||||
| Short Display | Appointment this response relates to | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | Reference(Appointment) | ||||||||
| Summary | true | ||||||||
| AppointmentResponse.proposedNewTime | |||||||||
| Element Id | AppointmentResponse.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 Display | Indicator for a counter proposal | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | boolean | ||||||||
| Summary | true | ||||||||
| AppointmentResponse.start | |||||||||
| Element Id | AppointmentResponse.start | ||||||||
| Definition | Date/Time that the appointment is to take place, or requested new start time. | ||||||||
| Short Display | Time from appointment, or requested new start time | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | instant | ||||||||
| Summary | false | ||||||||
| 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 Id | 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. | ||||||||
| Short Display | Time from appointment, or requested new end time | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | instant | ||||||||
| Summary | false | ||||||||
| AppointmentResponse.participantType | |||||||||
| Element Id | AppointmentResponse.participantType | ||||||||
| Definition | Role of participant in the appointment. | ||||||||
| Short Display | Role of participant in the appointment | ||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding | Participant Type (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 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. | ||||||||
| Invariants |
| ||||||||
| AppointmentResponse.actor | |||||||||
| Element Id | AppointmentResponse.actor | ||||||||
| Definition | A Person, Location, HealthcareService, or Device that is participating in the appointment. | ||||||||
| Short Display | Person(s), Location, HealthcareService, or Device | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference(Patient | Group | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | ||||||||
| Summary | true | ||||||||
| Invariants |
| ||||||||
| AppointmentResponse.participantStatus | |||||||||
| Element Id | 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. | ||||||||
| Short Display | accepted | declined | tentative | needs-action | entered-in-error | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Appointment Response Status (Required) | ||||||||
| Type | code | ||||||||
| 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) | ||||||||
| Summary | true | ||||||||
| 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 Id | AppointmentResponse.comment | ||||||||
| Definition | Additional comments about the appointment. | ||||||||
| Short Display | Additional comments | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | markdown | ||||||||
| Summary | false | ||||||||
| 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 Id | AppointmentResponse.recurring | ||||||||
| Definition | Indicates that this AppointmentResponse applies to all occurrences in a recurring request. | ||||||||
| Short Display | This response is for all occurrences in a recurring request | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | boolean | ||||||||
| Summary | false | ||||||||
| 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 Id | AppointmentResponse.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 | ||||||||
| Short Display | Original date within a recurring request | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | date | ||||||||
| Summary | false | ||||||||
| AppointmentResponse.recurrenceId | |||||||||
| Element Id | AppointmentResponse.recurrenceId | ||||||||
| Definition | The recurrence ID (sequence number) of the specific appointment when responding to a recurring request. | ||||||||
| Short Display | The recurrence ID of the specific recurring request | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | positiveInt | ||||||||
| Summary | false | ||||||||
| Comments | If the recurrence template was defined using the list of occurrenceDates then this property might not be used. | ||||||||
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:24+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change