Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

Version 1 Next »

FHIR resource link

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

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

FHIR definition

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

This resource is a record of a request for a communication to be performed. 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 schedule to send reminder or alert delivered to a patient or a practitioner which was previously scheduled.

required properties

see below

Extensions

Implemented: none

Under consideration:

  • enforcing mandatory fields

Sample payload

(minimum set)

Notes for CommunicationRequest FHIR resource, per property

Property

Required by PSI?

Notes

PSI tags

YES [psi/fhir]

Country ISO-2 code

/wiki/spaces/DHM/pages/13992045

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"
    }
]

How to use this in PSI.

This messages will be created to send notifications to the patients, org Units, or people related the projects. In some cases the communication will be created in the applications (send a voucher code notification, to welcome someone to a service, receive some message from a patient, give a response when service receives a messages or to generate a message from a reminder (CommunicationRequest)

  • No labels