Qodex.ai

Get Questionnaire by ID

GET {{baseUrl}}/api/v2/Questionnaire/:questionnaire-id

Overview:

Fetches the Questionnaire resource identified by the supplied internal id value.

This is only supported in ATHENA.

Use Cases:

  • Retrieve Specific Questionnaire: Obtain details of a particular questionnaire

  • Access Questionnaire Information: Retrieve general questionnaire details

  • Query Question Types: Obtain details of specific question types in a questionnaire

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

  • Examine Usage Statistics: Retrieve usage statistics for a specific 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","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","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"}}]}]}}]