Release 5 Draft Ballot
WorkflowThis page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). 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
| 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. | ||||||||
| 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. | ||||||||
| 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. | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | Reference(Appointment) | ||||||||
| Summary | true | ||||||||
| AppointmentResponse.start | |||||||||
| Element Id | AppointmentResponse.start | ||||||||
| Definition | Date/Time that the appointment is to take place, 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. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | instant | ||||||||
| Summary | false | ||||||||
| AppointmentResponse.participantType | |||||||||
| Element Id | AppointmentResponse.participantType | ||||||||
| Definition | Role of participant in the appointment. | ||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding | ParticipantType (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. | ||||||||
| AppointmentResponse.actor | |||||||||
| Element Id | AppointmentResponse.actor | ||||||||
| Definition | A Person, Location, HealthcareService, or Device that is participating in the appointment. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | ||||||||
| Patterns | Reference(Patient,Practitioner,PractitionerRole,RelatedPerson,Device,HealthcareService,Location): Common patterns = Participant | ||||||||
| Summary | true | ||||||||
| 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. | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | ParticipationStatus (Required) | ||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: Not known why this is labelled a modifier) | ||||||||
| 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. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| Comments | This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why. | ||||||||
FHIR ®© HL7.org 2011+. FHIR R5 Draft Ballot hl7.fhir.core#4.6.0 generated on Thu, Apr 15, 2021 12:28+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change