Configuring Surveys

Azodha’s survey module closely follows the FHIR (Fast Healthcare Interoperability Resources) specification, ensuring seamless integration with healthcare systems and interoperability across platforms.

Benefits of Following the FHIR Spec

1. Interoperability: Ensures that survey data can easily integrate with other healthcare systems and EHRs.

2. Standardization: Adopts widely recognized standards, improving consistency in healthcare data collection.

3. Scalability: This enables the platform to adapt and extend with future healthcare standards and changes in the FHIR framework.

Advanced Survey Features

1. Survey Versioning

Beyond basic survey functionality, Azodha’s platform supports versioning of surveys:

• Ensures accuracy over time by maintaining historical versions of surveys.

• Facilitates longitudinal data collection, enabling comparisons across different survey versions.

• Allows dynamic updates without impacting previously collected data or ongoing surveys.

2. Liquid Templates for Surveys

Each survey can have a Liquid template attached to render survey responses in a custom format:

• Responses can be converted to PDFs at key stages (completed, signed, or step-by-step) for easy provider review.

• This feature improves usability for providers, ensuring responses are well-structured and easy to analyze.

• Customized PDFs allow providers to present or archive data in a format suited to their workflow needs.

Surveys vs. Survey Responses

• Surveys: These are the structured questionnaires created for an organization.

• Survey Responses: These are individual responses submitted by patients after completing surveys. The responses reflect patient-specific inputs and progress over time.

When a survey is assigned to a patient it creates a survey response, the patient interacts with the survey to fill in the responses, which are then stored as survey responses distinct from the original survey structure.

APIs used to setup and configure a survey

Create a survey

post

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
or
string · date-timeOptional
lastReviewDateone ofOptional
string · dateOptional
or
string · date-timeOptional
dateone ofOptional
string · dateOptional
or
string · date-timeOptional
derivedFromstring[]Optional
subjectTypestring[]Optional
effectivePeriodanyOptional
textanyOptional
metaanyOptional
attributesanyOptional
Responses
200Success
application/json
post
/surveys
200Success

Get all surveys of organization

get

Retrieve all surveys for the organization

Query parameters
idstring[]Optional
surveyIdstring[]Optional
statusstring[]Optional
namestring[]Optional
orderBystringOptional
orderDirectionstringOptional
Responses
200Success
application/json
get
/surveys
200Success

Get a survey

get

Retrieve a specific survey by ID

Path parameters
surveyIdstringRequiredPattern: [^\/#\?]+?
Responses
200Success
application/json
get
/surveys/{surveyId}
200Success

Create a duplicate survey

post

Create a duplicate of an existing survey

Path parameters
surveyIdstringRequiredPattern: [^\/#\?]+?
Responses
200Success
application/json
post
/surveys/version/{surveyId}
200Success

Update a survey

put

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
or
string · date-timeOptional
lastReviewDateone ofOptional
string · dateOptional
or
string · date-timeOptional
dateone ofOptional
string · dateOptional
or
string · date-timeOptional
derivedFromstring[]Optional
subjectTypestring[]Optional
effectivePeriodanyOptional
textanyOptional
metaanyOptional
attributesanyOptional
Responses
200Success
application/json
put
/surveys/{surveyId}
200Success

Create questions

post

Create new questions for a survey

Body
anyOptional
Responses
200Success
application/json
post
/surveys/questions
200Success

Update a question

put

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