...
| HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| ||||
Write |
|
| ||||
Attributes | ||||||
Allergen | CodeableConcept | The allergen. |
| Allergy listing page | ||
Onset Timestamp | Timestamp | When the symptoms began. |
| Allergy listing page | ||
End Timestamp | Timestamp | When the symptoms ended. | ||||
Reactions | CodeableConcept List | The reactions to the allergen. |
| Allergy listing page | ||
Severity | CodeableConcept | How severe the reaction to the allergen is. |
| Allergy listing page | ||
Status | Enum |
| ||||
Appointment
Class Diagram
Display
Appointments appear in the Diary > Calendar page of the patient's record.
Please see the manual for more information.
Entity: Appointment - Extends: Data Point
...
...
HL7 API
...
FHIR API (Facade)
...
Custom REST API
...
Web (Patient)
...
Summary of interactions
...
Read
...
...
...
...
...
Write
...
SIU S12 /S13 /S14 /S15 /S26
ADT A05 /A14 /A27 /A38
...
...
...
...
Attributes
...
Type
...
Coding
...
The type of appointment.
...
...
...
...
Appointment details page
...
Start Timestamp
...
Timestamp
...
When the appointment starts.
...
SCH-11.4
EVN-3.1 (ADT)
PV1-44.1 (ADT)
PV2-8.1 (ADT)
...
...
...
Appointment listing page
Appointment details page
...
End Timestamp
...
Timestamp
...
When the appointment ends.
...
...
...
...
Appointment details page
...
Subject
...
String
...
A brief reason for the appointment.
...
...
...
...
Appointment listings page
Appointment details page
...
Description
...
String
...
A longer explanation of the appointment.
...
...
...
...
Appointment details page
...
Location
...
String
...
Where the appointment is to be held.
...
...
...
...
Appointment details page
...
Status
...
Enum
...
ACTIVE
CANCELLED
DNA
...
...
...
...
Appointment listings page
...
External Management URL
...
String
...
A deep link URL to an external appointment interface, where this appointment can be managed.
...
...
The presence of a link will enable the “Manage” option.
Entity: Appointment Participant
...
Attribute
...
Type
...
Description
...
HL7 API
...
FHIR API (Facade)
...
Custom REST API
...
Web (Patient)
...
User Public ID
...
Ref :
[[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.
...
...
Appointment details page
...
Status
...
Enum
...
ACCEPTED
...
The status is always Accepted.
...
...
The status is always Accepted.
Entity: External Appointment Participant
...
Attribute
...
Type
...
Description
...
HL7 API
...
FHIR API (Facade)
...
Custom REST API
...
Web (Patient)
...
Name
...
String
...
The name of the participant (optionally including their role).
...
...
...
https://pkbdev.atlassian.net/wiki/spaces/api/pages/3729195048/Entity+Appointment
Care Plan
Class Diagram
...