Developer documentation‎ > ‎FHIR® REST API‎ > ‎Roadmap‎ > ‎Operations‎ > ‎

Send Questionnaire

$send-questionnaire Operation

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

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

Status

In development. API spec subject to change.

Overview

This operation can be used to trigger a [[Consultation Request]] to be sent to either a specific Patient, or else to all Patients in a specific Team.

The Patients will receive the invitation via the normal PKB workflow, and can complete the Consultation in the PKB web interface.

The response will be made available as a QuestionnaireResponse.

Endpoints

InteractionHTTPURLSupported ParametersPermitted User TypesDescriptionExamples
operationPOST/Questionnaire/<id>/$send-questionnaireNone
  • Professional
  • Team Coordinator
  • System User
Send a questionnaire to a specific Patient, or to all patients in a specific Team./Questionnaire/a3024489-20de-4cad-87e4-ff5a9405a792/$send-questionnaire

Mappings

FHIRPKBNotes
OperationDefinition.url"http://fhir.patientsknowbest.com/operation/send-questionnaire" 
OperationDefinition.name"send-questionnaire" 
OperationDefinition.status"active" 
OperationDefinition.kind"operation" 
OperationDefinition.code"send-questionnaire" 
OperationDefinition.resource
  • "Questionnaire"
 
OperationDefinition.systemfalse 
OperationDefinition.typefalse 
OperationDefinition.instancetrue 
OperationDefinition.parameter
  • parameter[x]: BackboneElement
    • name = "target"
    • use = "in"
    • min = 1
    • max = "1"
    • type = "Reference"
    • searchType = "reference"
  • parameter[x]: BackboneElement
    • name = "recipient"
    • use = "out"
    • min = 0
    • max = "*"
    • type = "Reference"
    • searchType = "reference"
 
Comments