Get list of Questionnaire

GET {{baseUrl}}/api/v2/Questionnaire

Overview:

Retrieves a collection of Questionnaire resources matching given search parameters.

This is only supported in ATHENA.

Use Cases:

  • Retrieve Questionnaire: Obtain details of a specific questionnaire

  • Access Questionnaire List: Retrieve a list of available questionnaires

  • Query Question Types: Obtain details of specific question types

  • Review Response Options: Access details of response options in a questionnaire

  • Examine Usage Statistics: Retrieve usage statistics for a questionnaire

HEADERS

KeyDatatypeRequiredDescription
x-source-idstring(Required) Source ID
Authorizationstring

RESPONSES

status: OK

[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","name":"\u003cstring\u003e","id":"\u003cstring\u003e","item":[{"text":"\u003cstring\u003e","type":"\u003cstring\u003e","linkId":"\u003cstring\u003e","id":"\u003cstring\u003e","extensions":[{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"}],"answerOption":[{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]},{"text":"\u003cstring\u003e","type":"\u003cstring\u003e","linkId":"\u003cstring\u003e","id":"\u003cstring\u003e","extensions":[{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"}],"answerOption":[{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]}]}},{"resource":{"resourceType":"\u003cstring\u003e","name":"\u003cstring\u003e","id":"\u003cstring\u003e","item":[{"text":"\u003cstring\u003e","type":"\u003cstring\u003e","linkId":"\u003cstring\u003e","id":"\u003cstring\u003e","extensions":[{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"}],"answerOption":[{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]},{"text":"\u003cstring\u003e","type":"\u003cstring\u003e","linkId":"\u003cstring\u003e","id":"\u003cstring\u003e","extensions":[{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"}],"answerOption":[{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]}]}}]}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","name":"\u003cstring\u003e","id":"\u003cstring\u003e","item":[{"text":"\u003cstring\u003e","type":"\u003cstring\u003e","linkId":"\u003cstring\u003e","id":"\u003cstring\u003e","extensions":[{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"}],"answerOption":[{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]},{"text":"\u003cstring\u003e","type":"\u003cstring\u003e","linkId":"\u003cstring\u003e","id":"\u003cstring\u003e","extensions":[{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"}],"answerOption":[{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]}]}},{"resource":{"resourceType":"\u003cstring\u003e","name":"\u003cstring\u003e","id":"\u003cstring\u003e","item":[{"text":"\u003cstring\u003e","type":"\u003cstring\u003e","linkId":"\u003cstring\u003e","id":"\u003cstring\u003e","extensions":[{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"}],"answerOption":[{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]},{"text":"\u003cstring\u003e","type":"\u003cstring\u003e","linkId":"\u003cstring\u003e","id":"\u003cstring\u003e","extensions":[{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueId":"\u003cstring\u003e"}],"answerOption":[{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"valueCoding":{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]}]}}]}}]