This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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

5.27 Resource AppointmentResponse - Content

This resource maintained by the Patient Administration Work Group

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

5.27.1 Scope and Usage

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.

5.27.2 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . AppointmentResponse DomainResource A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
. . . identifier Σ 0..* Identifier External Ids for this item
. . . appointment Σ 1..1 Appointment Parent appointment that this response is replying to
. . . participantType Σ 0..* CodeableConcept Role of participant in the appointment
ParticipantType ( Required )
. . . actor Σ 0..1 Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location A Person, Location/HealthcareService or Device that is participating in the appointment
. . . participantStatus ?! Σ 1..1 code accepted | declined | tentative | in-process | completed | needs-action
ParticipantStatus ( Required )
. . . comment 0..1 string Additional comments about the appointment
. . . start 0..1 instant Date/Time that the appointment is to take place, or requested new start time
. . . end 0..1 instant Date/Time that the appointment is to conclude, or requested new end time

UML Diagram

AppointmentResponse ( DomainResource ) This records identifiers associated with this appointment response concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate identifier : Identifier 0..* Parent appointment that this response is replying to appointment : Reference ( Appointment ) 1..1 Role of participant in the appointment participantType : CodeableConcept 0..* « Role of participant in encounter ParticipantType » A Person, Location/HealthcareService or Device that is participating in the appointment actor : Reference ( Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location ) 0..1 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 modifies the meaning of other elements) participantStatus : code 1..1 « The Participation status of an appointment ParticipantStatus » This comment is particularly important when the responder is declining, tentative or requesting another time to indicate the reasons why comment : string 0..1 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 start : instant 0..1 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 end : instant 0..1

XML Template 

<AppointmentResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External Ids for this item --></identifier>
 <appointment><!-- 1..1 Reference(Appointment) 
     Parent appointment that this response is replying to --></appointment>
 <participantType><!-- 0..* CodeableConcept Role of participant in the appointment --></participantType>
 <actor><!-- 0..1 Reference(Patient|Practitioner|RelatedPerson|Device|
   HealthcareService|Location) 
     A Person, Location/HealthcareService or Device that is participating in the appointment --></actor>
 <participantStatus value="[code]"/><!-- 1..1 accepted | declined | tentative | in-process | completed | needs-action -->
 <comment value="[string]"/><!-- 0..1 Additional comments about the appointment -->
 <start value="[instant]"/><!-- 0..1 Date/Time that the appointment is to take place, or requested new start time -->
 <end value="[instant]"/><!-- 0..1 Date/Time that the appointment is to conclude, or requested new end time -->
</AppointmentResponse>

JSON Template 

{doco
  "resourceType" : "AppointmentResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this item
  "appointment" : { Reference(Appointment) }, // R!  
     Parent appointment that this response is replying to
  "participantType" : [{ CodeableConcept }], // Role of participant in the appointment
  "actor" : { Reference(Patient|Practitioner|RelatedPerson|Device|
   HealthcareService|Location) }, // 
     A Person, Location/HealthcareService or Device that is participating in the appointment
  "participantStatus" : "<code>", // R!  accepted | declined | tentative | in-process | completed | needs-action
  "comment" : "<string>", // Additional comments about the appointment
  "start" : "<instant>", // Date/Time that the appointment is to take place, or requested new start time
  "end" : "<instant>" // Date/Time that the appointment is to conclude, or requested new end time
}

Structure

Name Flags Card. Type Description & Constraints doco
. . AppointmentResponse DomainResource A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
. . . identifier Σ 0..* Identifier External Ids for this item
. . . appointment Σ 1..1 Appointment Parent appointment that this response is replying to
. . . participantType Σ 0..* CodeableConcept Role of participant in the appointment
ParticipantType ( Required )
. . . actor Σ 0..1 Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location A Person, Location/HealthcareService or Device that is participating in the appointment
. . . participantStatus ?! Σ 1..1 code accepted | declined | tentative | in-process | completed | needs-action
ParticipantStatus ( Required )
. . . comment 0..1 string Additional comments about the appointment
. . . start 0..1 instant Date/Time that the appointment is to take place, or requested new start time
. . . end 0..1 instant Date/Time that the appointment is to conclude, or requested new end time

UML Diagram

AppointmentResponse ( DomainResource ) This records identifiers associated with this appointment response concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate identifier : Identifier 0..* Parent appointment that this response is replying to appointment : Reference ( Appointment ) 1..1 Role of participant in the appointment participantType : CodeableConcept 0..* « Role of participant in encounter ParticipantType » A Person, Location/HealthcareService or Device that is participating in the appointment actor : Reference ( Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location ) 0..1 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 modifies the meaning of other elements) participantStatus : code 1..1 « The Participation status of an appointment ParticipantStatus » This comment is particularly important when the responder is declining, tentative or requesting another time to indicate the reasons why comment : string 0..1 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 start : instant 0..1 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 end : instant 0..1

XML Template 

<AppointmentResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External Ids for this item --></identifier>
 <appointment><!-- 1..1 Reference(Appointment) 
     Parent appointment that this response is replying to --></appointment>
 <participantType><!-- 0..* CodeableConcept Role of participant in the appointment --></participantType>
 <actor><!-- 0..1 Reference(Patient|Practitioner|RelatedPerson|Device|
   HealthcareService|Location) 
     A Person, Location/HealthcareService or Device that is participating in the appointment --></actor>
 <participantStatus value="[code]"/><!-- 1..1 accepted | declined | tentative | in-process | completed | needs-action -->
 <comment value="[string]"/><!-- 0..1 Additional comments about the appointment -->
 <start value="[instant]"/><!-- 0..1 Date/Time that the appointment is to take place, or requested new start time -->
 <end value="[instant]"/><!-- 0..1 Date/Time that the appointment is to conclude, or requested new end time -->
</AppointmentResponse>

JSON Template 

{doco
  "resourceType" : "AppointmentResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this item
  "appointment" : { Reference(Appointment) }, // R!  
     Parent appointment that this response is replying to
  "participantType" : [{ CodeableConcept }], // Role of participant in the appointment
  "actor" : { Reference(Patient|Practitioner|RelatedPerson|Device|
   HealthcareService|Location) }, // 
     A Person, Location/HealthcareService or Device that is participating in the appointment
  "participantStatus" : "<code>", // R!  accepted | declined | tentative | in-process | completed | needs-action
  "comment" : "<string>", // Additional comments about the appointment
  "start" : "<instant>", // Date/Time that the appointment is to take place, or requested new start time
  "end" : "<instant>" // Date/Time that the appointment is to conclude, or requested new end time
}

 

Alternate definitions: Schema / Schematron , Resource Profile ( XML , JSON ), Questionnaire

5.27.2.1 Terminology Bindings

Path Definition Type Reference
AppointmentResponse.participantType Role of participant in encounter Required http://hl7.org/fhir/vs/encounter-participant-type
AppointmentResponse.participantStatus The Participation status of an appointment Required http://hl7.org/fhir/participantstatus

5.27.3 Notes:

5.27.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Paths
actor reference The Person, Location/HealthcareService or Device that this appointment response replies for AppointmentResponse.actor
( Device , Location , HealthcareService , Patient , Practitioner , RelatedPerson )
appointment reference The appointment that the response is attached to AppointmentResponse.appointment
( Appointment )
location reference This Response is for this Location AppointmentResponse.actor
( Location )
partstatus token The participants acceptance status for this appointment AppointmentResponse.participantStatus
patient reference This Response is for this Patient AppointmentResponse.actor
( Patient )
practitioner reference This Response is for this Practitioner AppointmentResponse.actor
( Practitioner )