Configuring Surveys
Benefits of Following the FHIR Spec
Advanced Survey Features
1. Survey Versioning
2. Liquid Templates for Surveys
Surveys vs. Survey Responses
APIs used to setup and configure a survey
Create a new survey
Body
idstringOptional
resourceTypestringOptional
organizationIdnumberOptional
urlstringOptional
versionstringOptional
namestringOptional
titlestringRequired
publisherstringOptional
descriptionstringOptional
purposestringOptional
copyRightstringOptional
implicitRulesstringOptional
languagestringOptional
statusstring · enumRequiredPossible values:
experimentalbooleanOptional
approvalDateone ofOptional
string · dateOptional
string · date-timeOptional
lastReviewDateone ofOptional
string · dateOptional
string · date-timeOptional
dateone ofOptional
string · dateOptional
string · date-timeOptional
derivedFromstring[]Optional
subjectTypestring[]Optional
effectivePeriodanyOptional
textanyOptional
metaanyOptional
attributesanyOptional
Responses
200Success
application/json
post
/surveys200Success
Update an existing survey
Path parameters
surveyIdstringRequiredPattern:
[^\/#\?]+?Body
idstringOptional
resourceTypestringOptional
organizationIdnumberOptional
urlstringOptional
versionstringOptional
namestringOptional
titlestringRequired
publisherstringOptional
descriptionstringOptional
purposestringOptional
copyRightstringOptional
implicitRulesstringOptional
languagestringOptional
statusstring · enumRequiredPossible values:
experimentalbooleanOptional
approvalDateone ofOptional
string · dateOptional
string · date-timeOptional
lastReviewDateone ofOptional
string · dateOptional
string · date-timeOptional
dateone ofOptional
string · dateOptional
string · date-timeOptional
derivedFromstring[]Optional
subjectTypestring[]Optional
effectivePeriodanyOptional
textanyOptional
metaanyOptional
attributesanyOptional
Responses
200Success
application/json
put
/surveys/{surveyId}200Success
Update a specific question
Path parameters
questionIdstringRequiredPattern:
[^\/#\?]+?Body
idstringOptional
surveyIdstringOptional
maxLengthnumberOptional
pageNumbernumberRequired
parentQuestionIdstringOptional
ordernumberOptional
scorenumberOptional
answerValueSetstringOptional
linkIdstringRequired
headingstringRequired
labelstringRequired
definitionstringOptional
prefixstringOptional
textstringOptional
multiSelectbooleanOptional
typestring · enumRequiredPossible values:
displayTypestring · enumOptionalPossible values:
enableBehaviorstring · enumOptionalPossible values:
requiredbooleanOptional
repeatsbooleanOptional
readOnlybooleanOptional
attributesanyOptional
Responses
200Success
application/json
put
/surveys/questions/{questionId}200Success
Last updated
Was this helpful?