Versions Compared

Key

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

...

Property

Required by PSI?

Notes

PSI tags

Status
colourGreen
titleYes
[psi/fhir]

Country ISO-3 code

/wiki/spaces/DHM/pages/13992045

PENDING: implementation of this property

status

Status
colourGreen
titleREQUIRED
[fhir]

draft | active | on-hold | 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
colourYellow
titleoptional
[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": "SMSWRIT" },
  "text": "SMS"
}]

sender

Status
colourGreen
titleREQUIRED
[PSI/fhir]

Focus of message. Reference

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

subject

Status
colourGreen
titleREQUIRED
[PSI/fhir]

Focus of message. Reference

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

sent

Status
colourGreen
titleREQUIRED
[PSI/fhir]

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

occurrenceDateTime

Status
colourYellow
titleoptional
[fhir]

Status
colourGreen
titleREQUIRED
[PSI]

When scheduled (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]

Message payload template(the message body).

We have to send 2 elements.

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

topic

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