GetPathways

Returns the list of pathways shared with the currently logged-in patient.

JavaScript library method

patientportal.pathways.getPathways({
    pageSortColumn: <page-sort-column>,
    pageSortDescending: <page-sort-descending>,
    pageNumber: <page-number>,
    pageSize: <page-size>
});

HTTP Method

Verb	URL
GET	/patientportalapi/pathways/pathways

URL Parameters

Parameter	Type	Description
page-sort-column	int (optional)	The column index to sort the result: 0 – Last modified 1 – Pathway ID 3 – Due date 4 – Pathway name 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

PathwayOverviewData[]

Returned JSON

{
    "Items": [
        {
            "Key": "a1d3e2d1",
            "Number": "123",
            "Name": "Book & Arrive",
            "Patient": "Mr. Will Smith",
            "State": "In progress",
            "CurrentAction": "Book an appointment",
            "LastUpdate": "2015-03-13T14:22:12",
            "DueDate": "2015-03-13T14:52:30"
        }
    ],
    "TotalCount":1,
    "CurrentPage":1,
    "PageSize":10
}