STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 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

12.10 Resource AppointmentResponse - Content

Patient Administration Work GroupMaturity Level: 1Compartments: Device, Patient, Practitioner, RelatedPerson

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

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

12.10.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse IDomainResourceA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
Either the participantType or actor must be specified
... identifier Σ0..*IdentifierExternal Ids for this item
... appointment Σ1..1Reference(Appointment)Appointment this response relates to
... start 0..1instantTime from appointment, or requested new start time
... end 0..1instantTime from appointment, or requested new end time
... participantType Σ0..*CodeableConceptRole of participant in the appointment
ParticipantType (Extensible)
... actor Σ0..1Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location)Person, Location/HealthcareService or Device
... participantStatus ?!Σ1..1codeaccepted | declined | tentative | in-process | completed | needs-action | entered-in-error
ParticipationStatus (Required)
... comment 0..1stringAdditional comments

doco Documentation for this format

UML Diagram (Legend)

AppointmentResponse (DomainResource)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 appropriateidentifier : Identifier [0..*]Appointment that this response is replying toappointment : Reference [1..1] « Appointment »Date/Time that the appointment is to take place, or requested new start timestart : 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 timeend : instant [0..1]Role of participant in the appointmentparticipantType : CodeableConcept [0..*] « Role of participant in encounter. (Strength=Extensible)ParticipantType+ »A Person, Location/HealthcareService or Device that is participating in the appointmentactor : Reference [0..1] « Patient|Practitioner|RelatedPerson|Device| HealthcareService|Location »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. (Strength=Required)ParticipationStatus! »Additional comments about the appointmentcomment : string [0..1]

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:AppointmentResponse;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:AppointmentResponse.identifier [ Identifier ], ... ; # 0..* External Ids for this item
  fhir:AppointmentResponse.appointment [ Reference(Appointment) ]; # 1..1 Appointment this response relates to
  fhir:AppointmentResponse.start [ instant ]; # 0..1 Time from appointment, or requested new start time
  fhir:AppointmentResponse.end [ instant ]; # 0..1 Time from appointment, or requested new end time
  fhir:AppointmentResponse.participantType [ CodeableConcept ], ... ; # 0..* Role of participant in the appointment
  fhir:AppointmentResponse.actor [ Reference(Patient|Practitioner|RelatedPerson|Device|HealthcareService|Location) ]; # 0..1 Person, Location/HealthcareService or Device
  fhir:AppointmentResponse.participantStatus [ code ]; # 1..1 accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
  fhir:AppointmentResponse.comment [ string ]; # 0..1 Additional comments
]

Changes since DSTU2

AppointmentResponse
AppointmentResponse.participantType Change binding strength from required to extensible
AppointmentResponse.participantStatus Change value set from http://hl7.org/fhir/ValueSet/participantstatus to http://hl7.org/fhir/ValueSet/participationstatus

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse IDomainResourceA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
Either the participantType or actor must be specified
... identifier Σ0..*IdentifierExternal Ids for this item
... appointment Σ1..1Reference(Appointment)Appointment this response relates to
... start 0..1instantTime from appointment, or requested new start time
... end 0..1instantTime from appointment, or requested new end time
... participantType Σ0..*CodeableConceptRole of participant in the appointment
ParticipantType (Extensible)
... actor Σ0..1Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location)Person, Location/HealthcareService or Device
... participantStatus ?!Σ1..1codeaccepted | declined | tentative | in-process | completed | needs-action | entered-in-error
ParticipationStatus (Required)
... comment 0..1stringAdditional comments

doco Documentation for this format

UML Diagram (Legend)

AppointmentResponse (DomainResource)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 appropriateidentifier : Identifier [0..*]Appointment that this response is replying toappointment : Reference [1..1] « Appointment »Date/Time that the appointment is to take place, or requested new start timestart : 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 timeend : instant [0..1]Role of participant in the appointmentparticipantType : CodeableConcept [0..*] « Role of participant in encounter. (Strength=Extensible)ParticipantType+ »A Person, Location/HealthcareService or Device that is participating in the appointmentactor : Reference [0..1] « Patient|Practitioner|RelatedPerson|Device| HealthcareService|Location »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. (Strength=Required)ParticipationStatus! »Additional comments about the appointmentcomment : string [0..1]

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:AppointmentResponse;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:AppointmentResponse.identifier [ Identifier ], ... ; # 0..* External Ids for this item
  fhir:AppointmentResponse.appointment [ Reference(Appointment) ]; # 1..1 Appointment this response relates to
  fhir:AppointmentResponse.start [ instant ]; # 0..1 Time from appointment, or requested new start time
  fhir:AppointmentResponse.end [ instant ]; # 0..1 Time from appointment, or requested new end time
  fhir:AppointmentResponse.participantType [ CodeableConcept ], ... ; # 0..* Role of participant in the appointment
  fhir:AppointmentResponse.actor [ Reference(Patient|Practitioner|RelatedPerson|Device|HealthcareService|Location) ]; # 0..1 Person, Location/HealthcareService or Device
  fhir:AppointmentResponse.participantStatus [ code ]; # 1..1 accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
  fhir:AppointmentResponse.comment [ string ]; # 0..1 Additional comments
]

Changes since DSTU2

AppointmentResponse
AppointmentResponse.participantType Change binding strength from required to extensible
AppointmentResponse.participantStatus Change value set from http://hl7.org/fhir/ValueSet/participantstatus to http://hl7.org/fhir/ValueSet/participationstatus

See the Full Difference for further information

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),

12.10.2.1 Terminology Bindings

PathDefinitionTypeReference
AppointmentResponse.participantType Role of participant in encounter.ExtensibleParticipantType
AppointmentResponse.participantStatus The Participation status of an appointment.RequiredParticipationStatus

12.10.2.2 Constraints

  • apr-1: Either the participantType or actor must be specified (expression : participantType.exists() or actor.exists())

12.10.3 Notes:

  • Time zones and recurring appointments

    • Recurring appointments need to have the time zone 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 time zone it was created in, scheduling a 9am appointment 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 .

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

NameTypeDescriptionPathsIn Common
actorreferenceThe Person, Location/HealthcareService or Device that this appointment response replies forAppointmentResponse.actor
(Practitioner, Device, Patient, HealthcareService, RelatedPerson, Location)
appointmentreferenceThe appointment that the response is attached toAppointmentResponse.appointment
(Appointment)
identifiertokenAn Identifier in this appointment responseAppointmentResponse.identifier
locationreferenceThis Response is for this LocationAppointmentResponse.actor
(Location)
part-statustokenThe participants acceptance status for this appointmentAppointmentResponse.participantStatus
patientreferenceThis Response is for this PatientAppointmentResponse.actor
(Patient)
practitionerreferenceThis Response is for this PractitionerAppointmentResponse.actor
(Practitioner)