Versions Compared

Version Old Version 1 New Version Current
Changes made by

Gaspar

Rodolfo Melia

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. The requester requests the sender to send the payload to the recipient.

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)

Code Block
{
        "resourceType": "CommunicationRequest",
        "id": "924",
        "meta": {
            "versionId": "1",
            "lastUpdated": "2022-09-22T13:41:48.095+00:00"
        },
        "status": "active",
        "priority": "routine",
        "medium": [
            {
                "coding": [
                    {
                        "code": "APPWRIT"
                    }
                ],
                "text": "whatsapp"
            }
        ],
        "subject": {
            "reference": "Patient/202",
            "type": "Patient"
        },
        "recipient": [
            {
                "reference": "Patient/202",
                "type": "Patient"
            }
        ],
        "sender": {
            "reference": "Organization/736",
            "type": "Organization"
        },
        "payload": [
            {
                "contentString": ""
            },
            {
                "contentString": "Hi a test message from FHIR"
            }
        ],
        "occurrenceDateTime": "2022-09-23" 
    }

Notes for CommunicationRequest FHIR resource, per property

[psi/fhir]

Property

Required by PSI?

Notes

PSI tags

Status
colourGreen
titleYes
[psi/fhir]

Country ISO-2 3 code

/wiki/spaces/DHM/pages/13992045

PENDING: implementation of this property

status

colourYellow
titleoptional
Status
Status
colourGreen
titleREQUIRED
[fhir]

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

  • active: pending to be send

  • revoked: canceled (no need to send this message)

  • completed: message sent

Flow:

  • active--> completed

  • active → revoked

priority

Status
colourGreenYellow
titleREQUIREDoptional
[fhir]

routine | urgent | asap | stat
RequestPriority (Required)

medium

Status
colourGreen
titleREQUIRED
[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):

Code Block
[{ "coding": { "code": "APPWRITSMSWRIT" },
  "text": "whatsappSMS"
}]

subjectsender

Status
colourGreen
titleREQUIRED
[PSI/fhir]

Focus of message. Reference

Code Block
"sender": {
    "reference": "Organization/447",
    "type": "Organization"
},

subject

Status
colourGreen
titleREQUIRED
[PSI/fhir]

Refers to the patient (client) resource id that the voucher was assigned to

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

sent

Status
colourGreen
titleREQUIRED
[PSI/fhir]

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

receivedoccurrenceDateTime

Status
colourYellow
titleoptional
[fhir]

Status
colourGreen
titleREQUIRED
[PSI]

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

Required One of both: occurrenceDateTime or occurrencePeriod

occurrencePeriod

Status
colourYellow
titleoptional
[fhir]

Status
colourGreen
titleREQUIRED
[PSI]

When scheduled (Period)

Required One of both: occurrenceDateTime or occurrencePeriod

recipient

Status
colourGreen
titleREQUIRED
[psi]

Message recipient. Reference Array.

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

payload

Status
colourGreen
titleREQUIRED
[PSI/fhir]

Mesage Message payload template(the message body).

We have to send 2 elements.

  • 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)

  • first one is reserved to give information about term or plattform that contains the message/template.

  • The second one can be a text or a template. Related the template we have to explain all the possibilities and how to write them.

Code Block
 "payload": [{
       {"contentString": ""
  },
  {
      "contentString": "Hi {{patient.firstName}}, I´m a test message from FHIR"
 
  }
]

How to use this in PSI.

...

topic

Keyword to be able to relocate the message at a later state