2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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.25 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.25.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.

This should also cover the possible interactions between this resource and the appointment, including what it means, and what users are expected to do.

5.25.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse DomainResourceA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
... identifier 0..*IdentifierExternal Ids for this item
... appointment 1..1AppointmentParent appointment that this response is replying to
... participantType 0..*CodeableConceptRole of participant in the appointment
ParticipantType (Incomplete)
... individual 0..*AnyA Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device
... participantStatus 1..1codeaccepted | declined | tentative | in-process | completed | needs-action
ParticipantStatus (Required)
... comment 0..1stringAdditional comments about the appointment
... start 0..1instantDate/Time that the appointment is to take place
... end 0..1instantDate/Time that the appointment is to conclude
... lastModifiedBy 0..1Practitioner | Patient | RelatedPersonWho recorded the appointment response
... lastModified 0..1dateTimeDate when the response was recorded or last updated

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>
 <individual><!-- 0..* Reference(Any) 
     A Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device --></individual>
 <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 -->
 <end value="[instant]"/><!-- 0..1 Date/Time that the appointment is to conclude -->
 <lastModifiedBy><!-- 0..1 Reference(Practitioner|Patient|RelatedPerson) 
     Who recorded the appointment response --></lastModifiedBy>
 <lastModified value="[dateTime]"/><!-- 0..1 Date when the response was recorded or last updated -->
</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
  "individual" : [{ Reference(Any) }], // 
     A Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device
  "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
  "end" : "<instant>", // Date/Time that the appointment is to conclude
  "lastModifiedBy" : { Reference(Practitioner|Patient|RelatedPerson) }, // 
     Who recorded the appointment response
  "lastModified" : "<dateTime>" // Date when the response was recorded or last updated
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse DomainResourceA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
... identifier 0..*IdentifierExternal Ids for this item
... appointment 1..1AppointmentParent appointment that this response is replying to
... participantType 0..*CodeableConceptRole of participant in the appointment
ParticipantType (Incomplete)
... individual 0..*AnyA Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device
... participantStatus 1..1codeaccepted | declined | tentative | in-process | completed | needs-action
ParticipantStatus (Required)
... comment 0..1stringAdditional comments about the appointment
... start 0..1instantDate/Time that the appointment is to take place
... end 0..1instantDate/Time that the appointment is to conclude
... lastModifiedBy 0..1Practitioner | Patient | RelatedPersonWho recorded the appointment response
... lastModified 0..1dateTimeDate when the response was recorded or last updated

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>
 <individual><!-- 0..* Reference(Any) 
     A Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device --></individual>
 <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 -->
 <end value="[instant]"/><!-- 0..1 Date/Time that the appointment is to conclude -->
 <lastModifiedBy><!-- 0..1 Reference(Practitioner|Patient|RelatedPerson) 
     Who recorded the appointment response --></lastModifiedBy>
 <lastModified value="[dateTime]"/><!-- 0..1 Date when the response was recorded or last updated -->
</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
  "individual" : [{ Reference(Any) }], // 
     A Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device
  "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
  "end" : "<instant>", // Date/Time that the appointment is to conclude
  "lastModifiedBy" : { Reference(Practitioner|Patient|RelatedPerson) }, // 
     Who recorded the appointment response
  "lastModified" : "<dateTime>" // Date when the response was recorded or last updated
}

 

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

5.25.2.1 Terminology Bindings

PathDefinitionTypeReference
AppointmentResponse.participantType Role of participant in encounterIncompletehttp://hl7.org/fhir/vs/encounter-participant-type
AppointmentResponse.participantStatus The Participation status of an appointmentFixedhttp://hl7.org/fhir/participantstatus

5.25.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.25.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.

NameTypeDescriptionPaths
appointmentreferenceThe appointment that the response is attached toAppointmentResponse.appointment
(Appointment)
partstatustokenThe overall status of the appointmentAppointmentResponse.participantStatus
subjectreferenceThe subject that the appointment response replies forAppointmentResponse.individual
(Any)