GET api/v1/questionnaire/get?qid={qid}&date={date}&timingEvent={timingEvent}&offset={offset}

Retrive a questionnaire meta data and answers. Filtering based on the query parameters.

Request Information

Headers

URI Parameters

NameDescriptionTypeAdditional information
qid

The questionnaire identifier

string

Required

date

The date.

string

Required

timingEvent

The FHIR timing event reference

TimingEvent

Required

offset

Should the offset on the timestamp be calculated?

boolean

Default value is False

Body Parameters

None.

Response Information

Headers

Resource Description

QuestionnaireAnswers
NameDescriptionTypeAdditional information
Qid

The questionnaire identifier

string

Required

Timestamp

The timestamp of the questionnaire. ISO-8601 yyyy-MM-ddTHH:mm:sszzz

date

Required

Date

The date when the questionnaire is taken. ISO-8601 yyyy-MM-dd

string

Required

TimingEvent

The FHIR timing event reference

TimingEvent

Required

Completed

Flag if the questionnaire is completed.

integer

Required

Answers

A collection of one or more answers

Collection of Answers

Required

Response Formats

application/json

Sample:
{
  "Qid": "sample string 1",
  "Timestamp": "2025-02-03T10:47:46.3858725+00:00",
  "Date": "sample string 3",
  "TimingEvent": "HS",
  "Completed": 4,
  "Answers": [
    {
      "Aid": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Aid": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}