Send questionnaire request

http://fhir.patientsknowbest.com/operation/send-questionnaire-request

[Prod Resource]

https://www.hl7.org/fhir/STU3/operationdefinition.html

https://www.hl7.org/fhir/STU3/operations.html

name

"send-questionnaire-request"

status

"active"

kind

"operation"

description

This operation allows:

  • a System user to trigger a ProcedureRequest to be sent to either specific Patients, or else to all Patients in a specific Organization (PKB clinical team).

The Patient(s) will receive the invitation via the normal PKB workflow and can complete the Questionnaire in the PKB web interface.

The response will be made available as a QuestionnaireResponse.

code

"send-questionnaire-request"

resource

  • "Questionnaire"

system

false

type

false

instance

true

parameter

  • parameter[0]

    • name = "target"

    • use = "in"

    • min = 1

    • max = "500"

    • type = "Reference(Patient|Organization)"

    • documentation = “the target references can be either represented as a URL reference or through the use of an identifier representing the national health number. If a target is represented twice, only one request will be created per API call.“

  • parameter[1]

    • name = "requestor"

    • use = "in"

    • min = 1

    • max = "1"

    • type = "Reference(Practitioner)"

  • parameter[2]

    • name = “additionalIdentifier”

    • use = “in”

    • min = 0

    • max = “1”

    • type = “Identifier”

  • parameter[3]

    • name = “notificationFlag”

    • use = “in”

    • min = 0

    • max = “1”

    • type = “code”

    • documentation = “This code allows to enable or disable email notification sent to the requestor when a patient fills in a questionnaire response for this request. Accepted values are: ‘EMAIL_NOTIFICATION_ENABLED’ or ‘EMAIL_NOTIFICATION_DISABLED’. If no notificationFlag is provided it defaults to ‘EMAIL_NOTIFICATION_ENABLED’.“

  • parameter[4]

    • name = "request"

    • use = "out"

    • min = 0

    • max = "*"

    • type = "Reference(ProcedureRequest)"