Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Code Block
Sample code

Info

This page only list

status

 

 

FHIR resource link

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

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

FHIR definition

A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.

PSI use case

Storing of ‘conversation branches’ on bots or application ‘events’ (websites or applications like WFA)

FHIR required properties

PSI required properties*

authored

PII

Bots: should NEVER use Q. Response to store personal data.

Web/ Apps: If collected, it should be temporary, for internal processing, and NEVER send to the server AND should be explicitly declared on the associated Questionnaire

required properties*
(see details below)

status [fhir]
item [fhir]
questionnaire resource id [psi] (proposed as mandatory for ver FHIR 5.0)
authored [psi] dateTime, author and source

Extensions

Sample payload

(minimum set)

Live: NONE

UNDER CONSIDERATION:
Add a SumittedDataTime timestamp for each response?
(to be able to track the time spend in between question)

OR KEEP IN MATOMO ONLY?

As of Sept 5th, we are leaning NOT in FHIR, only in Matomo.

Sample payload

 

Notes for QuestionnaireResponse FHIR resource, per property

Property

Notes

tags

Status
colourGreen
titleREQUIRED
[psi]

countryISO & projectID

questionnaire

Status
colourGreen
titleREQUIRED
[psi]

Questionnaire resource ID [LINK]

status

Status
colourGreen
titleREQUIRED
[fhir]

To be used in analytics to filter out transactions

in-progress: partial posting, which should normally progress to another status like completed, amended or stopped.

amended: rarely used for bots.

stopped: when the user timeouts (more than X minutes) - is this feasible?

entered-in-error: for those ‘events' that need to be marked as deleted.

completed: ideal status for most entries. For Bots it means that the end of the branch was reached

subject

Status
colourGreen
titleREQUIRED
[psi]

[added Mar 10/2023]

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

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

authored

Status
colourGreen
titleREQUIRED
[PSIpsi]

time stamp timestamp for the conversation (sTART OR finished time)

author

Status
colourGreen
titleRequired
[psi]

The individual or device that received and recorded the answers

WFA: Practitioner ID

BOTS/Web: source: Does each bot / web site is represented by a practioner

Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)

source

Status
colourGreen
titleREQUIRED
[psi]

The individual or device that answered the questions

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

item

Status
colourGreen
titleREQUIRED
[fhir]

Group of questions and answers - rarely a single item

  • For Bot - the conversation branch

  • For web app; a form

*in addition to: countryISO * & projectID*