Appointment
The following topic describes information for the Appointment resource.
To interact with the REST endpoints in the Appointment resource, see Appointment.
Overview
The Appointment resource provides the ability to retrieve information about appointments, write new appointments, and update the status of existing appointments.
When integrating your application with a client's environments, work with the client to determine the practitioner and location IDs (Millennium personnel and location codes, respectively) that they want to make available to third-party applications for enabling scheduling functionality.
Appointment types for use in FHIR scheduling workflows must be resource list based. The ability to retrieve slots and book appointments that are order role based are not supported in FHIR workflows.
The status of arrived
does not change the state of the Millennium
appointment. Instead, the patient tracking status is updated to a value of
Arrived
.
When updating an appointment, the resource provides the ability to change the Appointment.status
in the following
sequences:
-
From
proposed
tobooked
orcancelled
-
From
booked
toarrived
,checked-in
, orcancelled
-
arrived
tochecked-in
orcancelled
-
From
checked-in
tofulfilled
orcancelled
Video Visit functionality requires additional licensing, configuration, and application support.
The following fields are returned if valued:
-
Extensions (for more information, see the Extensions section of this topic)
Teminology Bindings
-
Description: The coded reason for the appointment being canceled.
-
Details: Appointment cancellation reason
System:
http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason
-
Details: For more information, see Code Set 14229 Scheduling Appointment Cancellation Reason under the List of Code Sets section in Proprietary Codes and Systems.
System:
https://fhir.cerner.com/<EHR_source_id>/codeSet/14229
-
-
Description: Additional details about the categorization of the service.
-
Details: SNOMED CT
System:
http://snomed.info/sct
-
Details: appointmentReason
System:
http://terminology.hl7.org/CodeSystem/v2-0276
-
Details: For more information, see Code Set 16127 Schedule Processing Options under the List of Code Sets section in Proprietary Codes and Systems.
System:
https://fhir.cerner.com/<EHR_source_id>/codeSet/16127
-
-
Description: Additional details about where the content was created (for example, clinical specialty).
-
Details: Practice Setting Code Value Set
System:
http://snomed.info/sct
-
Details: For more information, see Code Set 14249 Scheduling Appointment Type Synonyms under the List of Code Sets section in Proprietary Codes and Systems.
System:
https://fhir.cerner.com/<EHR_source_id>/codeSet/14249
-
-
Description: A coded reason why this appointment is scheduled.
Note:
Currently not bound to any terminology. -
Description: The role of participant in the appointment.
Details: For more information, see Code Set 14250 Scheduling Resource Roles under the List of Code Sets section in Proprietary Codes and Systems.
System:
https://fhir.cerner.com/<EHR_source_id>/codeSet/14250
Extensions
All URLs for custom extensions are defined as
https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}
Table - Extensions
ID | Value[x} Type | Description |
---|---|---|
action-comment |
string |
The comment to be associated with the action performed on the resource. |
group-appointment-id |
string |
The ID of the appointment group that this appointment is part of. |
is-cancelable |
boolean |
An indication of whether the appointment can be canceled. |
is-reschedulable |
boolean |
An indication of whether the appointment can be rescheduled. |
reschedule-reason |
CodeableConcept |
The coded reason for the appointment being rescheduled. |
associated-encounter |
Reference |
A reference to the encounter associated with the appointment. |