GET api/v1/questionnaire/value/{questionnaireId}/period?value={value}&type={type}&offset={offset}

Retrive a collection of questionnaires over a period.

Request Information

Headers

URI Parameters

Name	Description	Type	Additional information
questionnaireId	The questionnaire identifier.	string	Required
value	The value.	integer	Required
type	The type.	PeriodType	Required
offset	Should the offset on the timestamp be calculated? true Use offset; false Use UTC.	boolean	Default value is False

Body Parameters

None.

Response Information

Headers

Resource Description

Collection of QuestionnaireAnswers

Name	Description	Type	Additional 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-03T11:10:36.8066312+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"
      }
    ]
  },
  {
    "Qid": "sample string 1",
    "Timestamp": "2025-02-03T11:10:36.8066312+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"
      }
    ]
  }
]