GetCases

Returns a list of cases filtered by any of the optional parameters specified.

JavaScript library method 

patientportal.cases.getCases({
    patient: <patient>,
    text: <text>,
    status: <status>,
    case: <case>,
    title: <title>,
    patientName: <patient-name>,
    department: <department>,
    division: <division>,
    pageSortColumn: <page-sort-column>,
    pageSortDescending: <page-sort-descending>,
    pageNumber: <page-number>,
    pageSize: <page-size>
});

HTTP Method

Verb URL
GET /patientportalapi/cases/cases

URL Parameters

</tbody></table> ## Returns [CaseOverviewData](../objects-and-data-types/caseoverviewdata)[] ## Returned JSON ```json { "Items": [ { "Key": 11229, "PatientName": "Lemon, John", "OpenedDate": "2024-01-01T09:30:00", "Title": "1st Case for this Patient", "LastUpdatedDate": "2024-01-01T09:30:00", "IsOpen": true } ], "TotalCount": 15, "CurrentPage": 1, "PageSize": 10, "SortColumn": 0, "SortDescending": false } ```

patient

string (optional)

The patient’s key id.

text

string (optional)

Checks if any of the attributes of the CaseOverviewData object contain .</p></td></tr>

status

int (optional)

  1. No filter (Default)
  2. Open cases
  3. Closed cases

case

Int (optional)

The case’s key id.

title

string (optional)

The public title of the case.

patientName

string (optional)

The patient’s name.

department

string (optional)

Key of the department provided by the API upon GetDepartments.

division

string (optional)

Key of the division provided by the API upon GetDepartments.

page-sort-column

int (optional)

The column index to sort the result:

  1. Case Key
  2. Person Name
  3. Case Title
  4. Opened Date
  5. Closed Date
  6. Last Updated Date

By default the result is sorted by last updated date.

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 5. Minimum 5. Maximum 50.