FHIR resource link

https://www.hl7.org/fhir/communication.html

https://build.fhir.org/communication.html

FHIR definition

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

This resource is a record of a communication even if it is planned or has failed. A communication is a conveyance of information from one entity, a sender, to another entity, a receiver.

PSI use cases

Communication use cases include:

• A reminder or alert delivered to a patient or a practitioner which was previously scheduled.

• Patient educational material sent by a provider to a patient

• Unable to deliver a message to a patient

• Incoming messages from a client (patient or practitioner)

required properties

see below

Extensions

Implemented: none

Under consideration:

• enforcing mandatory fields

Sample payload

(minimum set)

PSI tags

YES [psi/fhir]

Country ISO-2 code

Project Code

PENDING: implementation of this property

OPTIONAL [psi/fhir]

status

REQUIRED[fhir]

preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
EventStatus (Required)

priority

REQUIRED[fhir]

routine | urgent | asap | stat
RequestPriority (Required)

medium

REQUIRED[PSI/fhir]

A channel of communication. We can use one of these codes: SMSWRIT or APPWRIT. In the future we could use another codes (https://terminology.hl7.org/3.1.0/ValueSet-v3-ParticipationMode.html)

example for social media (code APPWRIT):

[{ "coding": { "code": "APPWRIT" },
  "text": "whatsapp"
}]

subject

REQUIRED[PSI/fhir]

Focus of message. Reference

"subject": {
    "reference": "fhir/Patient/446",
    "type": "Patient"
},

sent

REQUIRED[PSI/fhir]

When sent (datetime YYYY-MM-DDThh:mm:ss+zz:zz)

received

REQUIRED

When received(datetime YYYY-MM-DDThh:mm:ss+zz:z)

recipient

REQUIRED [psi]

Message recipient. Reference Array.

"recipient": [{
    "reference": "fhir/Patient/446",
    "type": "Patient"
}]

payload

REQUIRED[PSI/fhir]

Mesage payload (the message body). The message body is splitted in parts. This is useful for SMS (if we want to send a long message, we have to send multiple sms).

"payload": [
    {
        "contentString": "Hi, I´m a test message from FHIR"
    }
]