Page Comparison

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

Facade (STU3)

Aggregated (R4)

Summary of interactions

Create

Events & messages

Read

/Communication

Events & messages

/messages/after/<time>

Update

Events & messages

(only draft messages can be edited)

Delete

Events & messages

(only draft messages can be deleted)

Entity: Conversation

Conversation ID String

A unique ID identifying this conversation. This ID will not change even if the conversation is modified.

conversation-id

Not shown.

Entity: Message - Extends: Data Point

Timestamp Timestamp

When the message was sent.

Communication.sent

Shown.

Subject String

A brief description of what the message is about.

communication-title

Shown.

Content String

The content of the message.

Shown.

Is HTML Boolean

Whether the content should be interpreted as HTML, rather than plain text.

The web interface adjusts automatically.

Sender Ref: [[User.Public ID]]

The PKB user who sent the message.

Communication.sender

Shown.

Private Boolean

Whether or not the message is available to non-participants.

Note: This is a legacy feature. Messages can no longer be marked as private.

Legacy feature.

Status Enum

• DRAFT

• SENT

• UNREAD

• READ

An indication is shown for draft messages.

The colour of the conversation indicates whether or not the message has been read.

First Read Timestamp Timestamp

The server-assigned timestamp indicating when the patient first read the message in the PKB web interface.

Not shown.

Entity: Recipient

User Public ID Ref: [[User.Public ID]]

A PKB user who received the message.

Communication.recipient

The names of the recipients are shown.