Workflow
This
page
is
part
of
the
FHIR
Specification
(v1.0.2:
DSTU
(v3.0.2:
STU
2).
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
R3
R2
|
Patient
Administration
Work
Group
|
Maturity
Level
:
| Trial Use | Compartments : Device , Patient , Practitioner , RelatedPerson |
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.
When
an
appointment
is
required,
a
requester
creates
new
Appointment
resource
with
the
Appointment.status="proposed".
All
included
participants
(optional
or
mandatory)
should
have
the
status="needs-action"
to
allow
filtering
and
displaying
appointments
to
user-participants
for
accepting
or
rejecting
new
and
updated
requests.
Based
on
internal
system
business
rules,
certain
statuses
may
be
automatically
updated,
for
example:
"reject
because
the
requested
participant
is
on
vacation"
or
"this
type
of
user
is
not
allowed
to
request
those
specific
appointments".
The reply process is simply performed by the person/system handing the requests updating the participant statuses as needed. If there are multiple systems involved, then these will create AppointmentResponse entries with the desired statuses.
Once all participants have their participation status created/updated (and the main system marking the appointment participant records with the AppointmentResponse statuses) then the overall status of the Appointment is updated.
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 participantType or actor must be specified Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
identifier
|
Σ | 0..* | Identifier |
External
Ids
for
this
item
|
appointment
|
Σ | 1..1 | Reference ( Appointment ) | Appointment this response relates to |
start
|
0..1 | instant | Time from appointment, or requested new start time | |
|
end
|
0..1 | instant | 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 |
|
participantStatus
|
?! Σ | 1..1 | code |
accepted
|
declined
|
tentative
|
in-process
|
completed
|
needs-action
|
entered-in-error
|
comment
|
0..1 | string | Additional comments | |
|
Documentation
for
this
format
|
||||
UML Diagram ( Legend )
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
{ "resourceType" : "",{" " " " " "|"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 |
|
| AppointmentResponse.participantStatus |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See R2 <--> R3 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.).
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 participantType or actor must be specified Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
identifier
|
Σ | 0..* | Identifier |
External
Ids
for
this
item
|
|
appointment
|
Σ | 1..1 | Reference ( Appointment ) | Appointment this response relates to |
|
start
|
0..1 | instant | Time from appointment, or requested new start time | |
|
end
|
0..1 | instant | 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 |
|
participantStatus
|
?! Σ | 1..1 | code |
accepted
|
declined
|
tentative
|
in-process
|
completed
|
needs-action
|
entered-in-error
|
|
comment
|
0..1 | string | Additional comments | |
|
Documentation
for
this
format
|
||||
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
{ "resourceType" : "",{" " " " " "|"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 |
|
| AppointmentResponse.participantStatus |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See R2 <--> R3 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.).
Alternate
definitions:
Schema
/
Schematron
,
Resource
Profile
Master
Definition
(
XML
,
JSON
),
Questionnaire
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
| Path | Definition | Type | Reference |
|---|---|---|---|
| AppointmentResponse.participantType | Role of participant in encounter. |
|
ParticipantType |
| AppointmentResponse.participantStatus | The Participation status of an appointment. | Required |
|
:
Recurring
appointments
need
to
have
the
time
zone
defined
in
which
the
values
were
entered
in
defined.
entered.
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.
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 |
| In Common |
| actor | reference | The Person, Location/HealthcareService or Device that this appointment response replies for |
AppointmentResponse.actor
( Practitioner , Device , |
|
| appointment | reference | The appointment that the response is attached to |
AppointmentResponse.appointment
( Appointment ) |
|
| identifier | token | An Identifier in this appointment response | AppointmentResponse.identifier | |
| location | reference | This Response is for this Location |
AppointmentResponse.actor
( Location ) |
|
| part-status | 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 ) |
©
®©
HL7.org
2011+.
FHIR
DSTU2
(v1.0.2-7202)
Release
3
(STU;
v3.0.2-11200)
generated
on
Sat,
Thurs,
Oct
24,
2015
07:43+1100.
2019
11:53+1100.
QA
Page
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
|
Compare
to
DSTU1
DSTU2
|
|
Propose
a
change