Send questionnaire request

name

"send-questionnaire-request"

status

draft

kind

"operation"

description

This operation allows:

• a System user to trigger a ProcedureRequest to be sent to either a specific Patient, or else to all Patients in a specific Organization for a given Questionnaire.

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.

In addition to the OAuth 2.0 access token, the X-Org-Public-Id HTTP header must be provided in the request to specify the organisation that the system is calling on behalf of. The parameter will be the UUID of the PKB organisation.

code

"send-questionnaire-request"

resource

• "Questionnaire"

system

false

type

false

instance

true

parameter

• parameter[0]

  • name = "target"

  • use = "in"

  • min = 1

  • max = "1"

  • type = "Reference(Patient|Organization)"

• 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 = "request"

  • use = "out"

  • min = 0

  • max = "*"

  • type = "Reference(ProcedureRequest)"