Entity: Appointment
Class Diagram
Display
Appointments appear in the Diary > Calendar page of the patient's record.
Please see the manual for more information.
Solutions
PKB solutions related to this data type:
Mappings
| HL7 API | FHIR API (Customer boxes support full CRUD) | Web | Custom REST API | |
|
| Facade (STU3) | Aggregated (R4) | This is a summary. See the web spec for full details. |
|
Summary of interactions | |||||
Create |
|
|
| ||
Read |
|
| |||
Update |
|
|
| ||
Delete |
|
|
|
| |
Entity: Appointment - Extends: Data Point | |||||
Common ID An additional ID used only by appointments entities. |
|
| common-identifier | Not shown. |
|
Type The type of appointment. |
| serviceType | Type.Code is shown on the appointment details page. Other elements are not shown. |
| |
Start Timestamp When the appointment starts. | start | start | Shown. |
| |
End Timestamp When the appointment ends. | end | end | Shown. |
| |
Subject A brief reason for the appointment. | reason | appointmentType | Shown. |
| |
Description A longer explanation of the appointment. | comment | comment | Shown. |
| |
Location Where the appointment is to be held. | participant | participant | Shown. |
| |
Status
| status | status | If the Status is not ACTIVE then a message in red will be displayed. |
| |
External Management URL A deep link URL to an external appointment interface, where this appointment can be managed. |
|
| If an External Management URL is present than a “Manage” button will be shown to allow the user to launch the URL. |
| |
Entity: Appointment Participant | |||||
User Public ID The PKB user who is participating in the appointment. | When appointments are created via the HL7 API, the patient will be added as the only Appointment Participant. Use the AIP segment to add External Appointment Participants; the names of these attendees will be added to the Appointment without any link to a PKB User. | participant | participant | Shown. |
|
Status
| The status is always Accepted. | participant | participant | Not explicitly shown because always Accepted. |
|
Entity: External Appointment Participant | |||||
Name The name of the participant (optionally including their role). | participant | participant | Shown. |
| |