GetQuestionnaires

Returns the list of requested questionnaires. Questionnaires requested together (with or without a specific module) are listed together.

JavaScript library method

patientportal.questionnaires.getQuestionnaires({
    patient: <patient>,
    category: ‘ppq’,
    status: <status>,
    pageSortColumn: <page-sort-column>,
    pageSortDescending: <page-sort-descending>,
    pageNumber: <page-number>,
    pageSize: <page-size>
});

HTTP Method

Verb	URL
GET	/patientportalapi/questionnaires/questionnaires

URL Parameters

Parameter	Type	Description
patient	string (optional)	The key of the patient provided by the API upon GetPatients.
category	string (required)	Always ‘ppq’
status	int (optional)	Status code filter.
page-sort-column	int (optional)	The column index to sort the result: 0 – Created order 1 – Status Default: 0
page-sort-descending	int (optional)	True to sort result descending.
page-number	int (optional)	Page number. Default 1.
page-size	int (optional)	Page size. Default 10. Minimum 5. Maximum 50.

Returns

QuestionnaireOverviewData[]

Returned JSON

{
    "Items": [
        {
            "Key": "q13788",
            "Name": "Basic questionnaire",
            "Description": "",
            "StatusCode": 0,
            "Status": "Incomplete",
            "AppointmentKey": "apt5821",
            "Expiration": "2013-08-25",
            "Sent": "2013-07-01",
            "ReferralKey": "8ebb55f10382d73e494e7207d1bd7272",
            "CanRefer": 0
        }
    ],
    "TotalCount":24,
    "CurrentPage":1,
    "PageSize":10,
    "SortColumn": 0,
    "SortDescending": false
}