Screening Questionnaire

Screening Questionnaires are used to assess risk for or severity of disorders or conditions such as autism and depression. These questionnaires result in a score, and often include guidelines and proposed treatment actions. Screeners can be structured or score-only. The Screening Questionnaires Reference are configured in the system. The user will be able to retrieve the list of screening questionnaires for a specific encounter. Screeners can be structured or score-only.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Submit questionnaire screener for encounter
POST
/v1/{practiceid}/chart/encounter/{encounterid}/questionnairescreeners

Creates a new questionnaire screener record for the encounter

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
encounterid integer encounterid
Content-Type string Content type of the payload

❙ Request Body

Expand all
templateid integer The template ID for the screener that will be activated.

Output Parameters

Expand all
success string Flags this request as successful or not.
Example Code
Get questionnaire screeners for given encounter
GET
/v1/{practiceid}/chart/encounter/{encounterid}/questionnairescreeners

Retrieve a list of enabled questionnaire screeners for the encounter

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
encounterid integer encounterid
limit integer Number of entries to return (default 100, max 1000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
declinedreason object Reason the questionnaire is declined
documentids string The document IDs attached to the questionnaire.
guidelines string The guidelines recommended by the questionnaire
maximumscore integer The maximum amount of points for this questionnaire
metaquestions array Any meta questions related to this questionnaire. E.g., should this be considered generally as positive or negative?
name string The questionnaire name
note string The note attached to this questionnaire
questionnaireid integer The questionnaire ID
score integer The score for this questionnaire
scoredby string The user that scored this questionnaire
scoreddate string The date this questionnaire was scored
scoringstatus string The status of the questionnaire
sections array List of the sections for this questionnaire
templateid integer The template ID of the questionnaire. Required to activate a questionnaire for a given encounter.
templatetype string Boolean to flag whether the questionnaire is score only or not.
Example Code
Update questionnaire screener for encounter
PUT
/v1/{practiceid}/chart/encounter/{encounterid}/questionnairescreeners

Modifies the questionnaire screeners for the encounter

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
encounterid integer encounterid
Content-Type string Content type of the payload

❙ Request Body

Expand all
declinedreason object Not yet implemented. Reason the questionnaire is declined
documentids array The document ID to attach to the questionnaire. Multiple documents (either as a comma delimited list or multiple body parameters) are allowed.
guidelines string The guidelines given by the score and questionnaire.
metaquestions array Not yet implemented. Any meta questions related to this questionnaire. E.g., should this be considered generally as positive or negative?
note string The note for the questionnaire screener.
questionnaireid integer The questionnaire ID to be updated. If the questionnaireid does not exist in the GET /chart/encounter/{encounterid}/questionnairescreeners API, please activate it via the POST API.
questions array A JSON array of questions that contain a questionid and answer.
score integer The score for the questionnaire screener. This is not automatically updated based on the questions and answers passed in.
state string The state of the questionnaire. This is used exclusively for the PHQ2/9 screeners. If this is not explicitly passed in, the default behavior will set the state to a PHQ2 on a score lower than 3, otherwise it will be set to a PHQ9.

Output Parameters

Expand all
success string Flags this request as successful or not.
Example Code
Update score against encounter's questionnaire screener
PUT
/v1/{practiceid}/chart/encounter/{encounterid}/questionnairescreeners/scoreonly

Modifies only the score of the questionnaire screener for the encounter

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
encounterid integer encounterid
Content-Type string Content type of the payload

❙ Request Body

Expand all
declinedreason object Not yet implemented. Reason the questionnaire is declined
documentids array A comma delimited array of document IDs to attach to the questionnaire. Ex: [4,5]. Currently this is only officially supported for documents with the subclass ENCOUNTERDOCUMENT_PATIENTHISTORY.
metaquestions array Not yet implemented. Any meta questions related to this questionnaire. E.g., should this be considered generally as positive or negative?
note string The note for the questionnaire screener.
questionnaireid integer The questionnaire ID to be updated. If the questionnaireid does not exist in the GET /chart/encounter/{encounterid}/questionnairescreeners API, please activate it via the POST API.
score integer The score for the questionnaire screener. Screeners that have one or more scores should be entered in the NOTE field.

Output Parameters

Expand all
success string Flags this request as successful or not.
Example Code
Get list of questionnaire screeners
GET
/v1/{practiceid}/chart/questionnairescreeners

Retrieves a list of questionnaire screeners

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
name string The questionnaire name
templateid integer The template ID of the questionnaire. Required to activate a questionnaire for a given encounter.
templatetype string Boolean to flag whether the questionnaire is score only or not.
Example Code
Get list of questionnaire screeners given an appointment-ID or encounter-ID
GET
/v1/{practiceid}/chart/configuration/questionnairescreeners

Retrieve a list of possible questionnaire screeners for a given appointment ID or encounter ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
appointmentid integer The appointment ID. It is used solely to determine the specialty ID to determine possible questionnaires. If an encounter ID is passed in, it will take priority over the appointment ID.
departmentid integer The department ID.
patientid integer The patient ID.
encounterid integer The encounter ID. It is used solely to determine the specialty ID to determine the possible questionnaires.
patiententered boolean If true, only retrieve the questionnaires that are valid to be entered by a patient before checking the appointment in. These are the questionnaires that should be used with POST /appointments/{appointmentid}/questionnairescreeners.
limit integer Number of entries to return (default 100, max 1000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
declinedreason object Reason the questionnaire is declined
documentids string The document IDs attached to the questionnaire.
guidelines string The guidelines recommended by the questionnaire
maximumscore integer The maximum amount of points for this questionnaire
metaquestions array Any meta questions related to this questionnaire. E.g., should this be considered generally as positive or negative?
name string The questionnaire name
note string The note attached to this questionnaire
questionnaireid integer The questionnaire ID
score integer The score for this questionnaire
scoredby string The user that scored this questionnaire
scoreddate string The date this questionnaire was scored
scoringstatus string The status of the questionnaire
sections array List of the sections for this questionnaire
templateid integer The template ID of the questionnaire. Required to activate a questionnaire for a given encounter.
templatetype string Boolean to flag whether the questionnaire is score only or not.
Example Code