Path | Short | Definition | Comments |
---|---|---|---|
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. | ||
identifier | External Ids for this item | 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. | |
appointment | Appointment this response relates to | Appointment that this response is replying to. | |
start | Time from appointment, or requested new start time | Date/Time that the appointment is to take place, or requested new start time. | 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. |
end | Time from appointment, or requested new end time | 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. | |
participantType | Role of participant in the appointment | Role of participant in the appointment. | 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. |
actor | Person, Location, HealthcareService, or Device | A Person, Location, HealthcareService, or Device that is participating in the appointment. | |
participantStatus | accepted | declined | tentative | in-process | completed | needs-action | entered-in-error | 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. | This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid. |
comment | Additional comments | Additional comments about the appointment. | This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why. |
Appointment resources are used to provide information about a planned meeting that may be in the future or past. They may be for a single meeting or for a series of repeating visits. Examples include a scheduled surgery, a follow-up for a clinical visit, a scheduled conference call between clinicians to discuss a case, the reservation of a piece of diagnostic equipment for a particular use, etc. The visit scheduled by an appointment may be in person or remote (by phone, video conference, etc.). All that matters is that the time and usage of one or more individuals, locations and/or pieces of equipment is being fully or partially reserved for a designated period of time.
This definition takes the concepts of appointments in a clinical setting and also extends them to be relevant in the community healthcare space, and also ease exposure to other appointment / calendar standards widely used outside of Healthcare.
When an appointment is required, a requester creates new Appointment resource with the Appointment.status="proposed".
All included participants (optional or mandatory) should have the status="needs-action" to allow filtering and displaying
appointments to user-participants for accepting or rejecting new and updated requests. Based on internal system business rules,
certain statuses may be automatically updated, for example: "reject because the requested participant is on vacation" or
"this type of user is not allowed to request those specific appointments".
The reply process is simply performed by the person/system handing the requests updating the participant statuses as needed. If there are multiple systems involved, then these will create AppointmentResponse entries with the desired statuses.
Once all participants have their participation status created/updated (and the main system marking the appointment participant records with the AppointmentResponse statuses) then the overall status of the Appointment is updated.
Recurring appointments need to have the time zone defined in which the values were entered. Knowing that the start time was at 9:00:00Z+10 does not mean that the same time in 2 weeks is actually the same.
For example, if this was a time in Brisbane Australia, this time would be the same (in respect to its offset from UTC), however if this was for Melbourne Australia, during the daylight savings period Melbourne time zone becomes +11. So without the additional information as to which time zone it was created in, scheduling a 9am appointment every Wednesday would not be possible.
actor | The Person, Location/HealthcareService or Device that this appointment response replies for | AppointmentResponse.actor |
appointment | The appointment that the response is attached to | AppointmentResponse.appointment |
identifier | An Identifier in this appointment response | AppointmentResponse.identifier |
location | This Response is for this Location | AppointmentResponse.actor.where(resolve() is Location) |
part-status | The participants acceptance status for this appointment | AppointmentResponse.participantStatus |
patient | This Response is for this Patient | AppointmentResponse.actor.where(resolve() is Patient) |
practitioner | This Response is for this Practitioner | AppointmentResponse.actor.where(resolve() is Practitioner) |