This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). 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

• Content
• Examples
• Detailed Descriptions
• Mappings
• Profiles

5.28 Resource AppointmentResponse - Content

Patient Administration Work Group

Maturity Level: 0

Compartments: Device, Patient, Practitioner, RelatedPerson

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

5.28.2 Resource Content

• Structure
• UML
• XML
• JSON
• All

Structure

Name	Flags	Card.	Type	Description & Constraints
AppointmentResponse	I		DomainResource	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection Either the type or actor on the participant should be specified
identifier	Σ	0..*	Identifier	External Ids for this item
appointment	Σ	1..1	Reference(Appointment)	Parent appointment that this response is replying to
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
participantType	Σ	0..*	CodeableConcept	Role of participant in the appointment ParticipantType (Required)
actor	Σ	0..1	Reference(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
Documentation for this format

UML Diagram

XML Template

<AppointmentResponse xmlns="http://hl7.org/fhir"> 
 <!-- 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>
 <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 -->
 <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 -->
</AppointmentResponse>

JSON Template

{
  "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
  "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
  "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
}

Structure

Name	Flags	Card.	Type	Description & Constraints
AppointmentResponse	I		DomainResource	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection Either the type or actor on the participant should be specified
identifier	Σ	0..*	Identifier	External Ids for this item
appointment	Σ	1..1	Reference(Appointment)	Parent appointment that this response is replying to
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
participantType	Σ	0..*	CodeableConcept	Role of participant in the appointment ParticipantType (Required)
actor	Σ	0..1	Reference(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
Documentation for this format

UML Diagram

XML Template

<AppointmentResponse xmlns="http://hl7.org/fhir"> 
 <!-- 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>
 <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 -->
 <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 -->
</AppointmentResponse>

JSON Template

{
  "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
  "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
  "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
}

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

5.28.2.1 Terminology Bindings

5.28.2.2 Constraints

• apr-1: Either the type or actor on the participant should be specified (xpath: (exists(f:type) or exists(f:actor)))

5.28.3 Notes:

• Timezones and Recurring Appointments

Recurring appointments need to have the timezone in which the values were entered in defined. 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.

As if this was a time in Brisbane Australia, this time will be the same (in respect to its offset from UTC), however if this was for Melbourne Australia, during the daylight savings period of time Melbourne becomes +11. So without the additional information as to which timezone it was created in, scheduling a 9am appoitment every Wednesday would not be possible.

• Placer/Filler (HL7 v2)

The appointment information is effectively the same between the filler and placer, and given the nature of the fhir resource, there is only a single resource for both purposes. The Placer is the actor that performs the PUT or POST operation on the resource, and the filler is the actor that receives these resource messages and processes the information and makes a decision if the appointment can be used. Brian: Does this seem right that the filler and placer are applied in this way?

• Interaction with other Standards

The strong desire is that implementers of this resource should consider providing this resource in the iCalendar format as an alternative representation. Many 3rd party applications and component providers have parsers and user interface controls to display this information. This may lower the entry point to integrate outside the health-care specific applications, and into the consumer space. This would permit the easier creation of a mobile application that creates appointments in the devices native calendar.
The iCalendar specification can be found at http://www.ietf.org/rfc/rfc2445.txt .

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