Workflow
This page is part of the FHIR Specification (v1.6.0:
STU
3 Ballot 4). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions 
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
|
Compartments
|
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
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.
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
AppointmentResponse
|
I | DomainResource |
|
|
identifier
|
Σ | 0..* | Identifier |
|
appointment
|
Σ | 1..1 | Reference ( Appointment ) |
|
start
|
0..1 | instant |
|
|
|
end
|
0..1 | instant |
|
|
|
participantType
|
Σ | 0..* | CodeableConcept |
ParticipantType |
|
actor
|
Σ | 0..1 |
Reference
(
Patient
|
|
|
participantStatus
|
?! Σ | 1..1 | code |
|
comment
|
0..1 | string |
|
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
(
Legend
)
XML
Template
XML Template
<
<AppointmentResponse xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> <</appointment> < < <</participantType> <|<identifier><!-- 0..* Identifier External Ids for this item --></identifier> <appointment><!-- 1..1 Reference(Appointment) Appointment this response relates to --></appointment> <start value="[instant]"/><!-- 0..1 Time from appointment, or requested new start time --> <end value="[instant]"/><!-- 0..1 Time from appointment, 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) Person, Location/HealthcareService or Device --></actor>< <<participantStatus value="[code]"/><!-- 1..1 accepted | declined | tentative | in-process | completed | needs-action | entered-in-error --> <comment value="[string]"/><!-- 0..1 Additional comments --> </AppointmentResponse>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"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! Appointment this response relates to
"start" : "<instant>", // Time from appointment, or requested new start time
"end" : "<instant>", // Time from appointment, or requested new end time
"participantType" : [{ CodeableConcept }], // Role of participant in the appointment
"actor" : { Reference(Patient|Practitioner|RelatedPerson|Device|
HealthcareService|Location) }, // Person, Location/HealthcareService or Device
"
"
"participantStatus" : "<code>", // R! accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
"comment" : "<string>" // Additional comments
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
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
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
AppointmentResponse
|
I | DomainResource |
|
|
|
identifier
|
Σ | 0..* | Identifier |
|
|
appointment
|
Σ | 1..1 | Reference ( Appointment ) |
|
|
start
|
0..1 | instant |
|
|
|
end
|
0..1 | instant |
|
|
|
participantType
|
Σ | 0..* | CodeableConcept |
ParticipantType |
|
actor
|
Σ | 0..1 |
Reference
(
Patient
|
|
|
participantStatus
|
?! Σ | 1..1 | code |
|
|
comment
|
0..1 | string |
|
|
|
Documentation for this format
|
||||
XML
Template
XML Template
<
<AppointmentResponse xmlns="http://hl7.org/fhir"><</identifier> <</appointment> < < <</participantType> <|<identifier><!-- 0..* Identifier External Ids for this item --></identifier> <appointment><!-- 1..1 Reference(Appointment) Appointment this response relates to --></appointment> <start value="[instant]"/><!-- 0..1 Time from appointment, or requested new start time --> <end value="[instant]"/><!-- 0..1 Time from appointment, 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) Person, Location/HealthcareService or Device --></actor>< <<participantStatus value="[code]"/><!-- 1..1 accepted | declined | tentative | in-process | completed | needs-action | entered-in-error --> <comment value="[string]"/><!-- 0..1 Additional comments --> </AppointmentResponse>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"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! Appointment this response relates to
"start" : "<instant>", // Time from appointment, or requested new start time
"end" : "<instant>", // Time from appointment, or requested new end time
"participantType" : [{ CodeableConcept }], // Role of participant in the appointment
"actor" : { Reference(Patient|Practitioner|RelatedPerson|Device|
HealthcareService|Location) }, // Person, Location/HealthcareService or Device
"
"
"participantStatus" : "<code>", // R! accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
"comment" : "<string>" // Additional comments
}
Alternate
definitions:
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
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
,
Resource
Profile
(
XML
,
(for ) +
JSON
Schema
,
ShEx
(for
Turtle
),
Questionnaire
)
| Path | Definition | Type | Reference |
|---|---|---|---|
| AppointmentResponse.participantType |
|
|
ParticipantType |
| AppointmentResponse.participantStatus |
|
Required |
|
:
participantType.exists() or actor.exists()
)
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.
)
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?
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
.
.
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| actor | reference |
|
AppointmentResponse.actor
( |
| appointment | reference |
|
AppointmentResponse.appointment
( Appointment ) |
| identifier | token |
|
AppointmentResponse.identifier |
| location | reference |
|
AppointmentResponse.actor
( Location ) |
| part-status | token |
|
AppointmentResponse.participantStatus |
| patient | reference |
|
AppointmentResponse.actor
( Patient ) |
| practitioner | reference |
|
AppointmentResponse.actor
( Practitioner ) |
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000.
QA Page
Links:
Search
|
|
Version History
|
Table of Contents
|
Compare to DSTU2
|
|
Propose
a
change
try
{
var
currentTabIndex
=
sessionStorage.getItem('fhir-resource-tab-index');
}
catch(exception){
}
if
(!currentTabIndex)
currentTabIndex
=
'0';
$(
'#tabs'
).tabs({
active:
currentTabIndex,
activate:
function(
event,
ui
)
{
var
active
=
$('.selector').tabs('option',
'active');
currentTabIndex
=
ui.newTab.index();
document.activeElement.blur();
try
{
sessionStorage.setItem('fhir-resource-tab-index',
currentTabIndex);
}
catch(exception){
}
}
});
|
Propose a change