home api list

Hexostore API Documentation

question

/api/question/

List methods: get

Detail methods: options, get

Allow to get a specific question with /api/question// or return all questions if no id is provided.
A question is a field resource used in a questionnaire.
For more information on what is a survey, check the study section here
For more information on how to submit a survey response, check surveyanswers or csvsurveyanswers

Fields

id: CharField

This field is readonly.

type: SerializerMethodField

group | display | boolean | decimal | integer | date | dateTime + More information

This field is readonly.

linkId: CharField

This is identical to id, but is kept for fhir questionnaire handling More information

This field will default to: '' (empty string)

answerOption: ListSerializer

More information

This field may be blank

This field will default to: '' (empty string)

repeats: BooleanField

Whether the item may repeat More information

This field may be blank

This field will default to: '' (empty string)

item: SerializerMethodField

Subquestions when Question type is "group"

This field is readonly.

text: CharField

Primary text for the item

This field will default to: '' (empty string)

Filtering Options

id: exact, in, gt, gte, lt, lte, range

Sorting Options

No sorting supported

© 2024 by CarrĂ© Technologies Inc.