GetPatients

Returns the list of patients. Note that the list includes only patients the logged in user is allowed to view.

JavaScript library method 

patientportal.patients.getPatients({
    text: <text>,
    name: <name>,
    surname: <surname>,
    department: <department>,
    division: <division>,
    personalEmail: <personal-email>,
    workEmail: <work-email>,
    employeeNumber: <employee-number>,
    dobFrom: <dob-from>,
    dobTo: <dob-to>,
    pageSortColumn: <page-sort-column>,
    pageSortDescending: <page-sort-descending>,
    pageNumber: <page-number>,
    pageSize: <page-size>
});

HTTP Method

Verb URL
GET /patientportalapi/patients/patients

URL Parameters

Parameter Type Description
text string (optional) Any text the API will try to filter by name, email or employee number.
name string (optional) Name filter.
surname string (optional) Surname filter.
department string (optional) Key of the department provided by the API upon GetDepartmentsAndDivisions.
division string (optional) Key of the division provided by the API upon GetDepartmentsAndDivisions.
personal-email string (optional) Personal email filter.
work-email string (optional) Work email filter.
employee-number string (optional) Employee number filter.
dob-from string (optional) Filter by DOB from. If provided the patients without DOB are filtered out.
dob-to string (optional) Filter by DOB to. If provided the patients without DOB are filtered out.
page-sort-column int (optional)

The column index to sort the result:

  • 0 – Patient’s name
  • 1 – Email address
  • 2 - <ignored>
  • 3 – Employee number

By default the result is sorted by the user name.
page-sort-descending int (optional) True to sort result descending.
page-number int (optional) Required page number. Default 1.
page-size int (optional) Required page size. Default 10. Minimum 5. Maximum 50.

Returns

PersonDemographicData[]

Returned JSON 

{
    "Items": [
        {
            "Title": "Mr",
            "Name": "John",
            "Surname": "Lemon",
            "SexType": 1,
            "Initials": "JL",
            "DateOfBirth": "1958-08-02T00:00:00",
            "Mobile": "+444 895 523 411",
            "Telephone": "+444 525 111 555",
            "EmailAddress": "<john.lemon@test.com>",
            "WorkEmailAddress": "<john.lemon@mywork.com>",
            "Address": {
                "Address1": "Studio 99",
                "Address2": "Backlok Street",
                "Address3": "Camden",
                "City": "London",
                "County": "",
                "PostCode": "N1 7NK",
                "Country": "United Kingdom"
            },
            "NextOfKin": {
                "Relationship": "Mam",
                "Name": "Mariel",
                "Surname": "Lemon",
                "Mobile": "+444 895 111 222",
                "WorkTelephone": "+444 525 111 555",
                "Address": {
                    "Address1": "Studio 1",
                    "Address2": "Cardwell Roa",
                    "Address3": "Camden",
                    "City": "London",
                    "County": "",
                    "PostCode": "N1 7NK",
                    "Country": "United Kingdom"
                }
            }
        }
    ],
    "TotalCount":1,
    "CurrentPage":1,
    "PageSize":10,
    "SortColumn": 0,
    "SortDescending": false
}