V3 API GetFilteredConsultationsList

Get Filtered Consultations List

GET v3.1/patients/consultations/filter
GET v3.1/caregivers/consultations/filter

Returns a list of all consultations satisfying a filter.

Both URLs are equivalent, except they are intended to patients and patient presenters respectively.

Permissions

Patients are allowed to view only their own consultations and consultations of their authorized dependents.

Patient presenters should have Patient_Proxy role function and can view only consultations for patients, visible according to visibility rules.

Query string parameters

name	type	description	value
startDate	DateTime	Range for consultation start time (in current user time zone).	Default - any.
endDate
consultationStatus	string	Status of desired consultations.	One of the following values: 'Scheduled', 'Past', 'Dropped', 'DNA' or 'Active'. Required.
physicianUserId	int?	UserId of clinician to filter consultations.	Default - all.
patientId	int?	PatientId of a patient fo filter consultations.	Default - current patient id.
includeDependents	bool	Do include patient dependents in addition to patientId	Default - false.
patientOrPhysicianNameFilter	string	This string should match part of the patient of clinician full name.	Default - not use.
sortOrderFields	SortOrderField[]	List of fileds used to order result set.	Field name may be one of the 'date'/'time' (sort by start time), 'patient' (sort by patient full name), 'provider' (clinician full name) or 'length' (consultation duration). Default - no specific sort.
skip	int	How many result records to skip/return for pagination.	Default 0.
take			Default 20.

Result

Result is a list of consultations (of type PatientConsultationInfo[]) satisfying the filter. List may be empty.

Sample request

GET /api/v3.1/patients/consultations/filter?consultationStatus=past&startDate=2018-01-01&take=2&sortOrderFields[0][name]=date&sortOrderFields[0][direction]=Ascending

Sample response

[
    {
        "consultationId": 39473,
        "patientPersonId": "7c011cc3-ef7f-4a68-be33-e1b65ad4f63f",
        "providerPersonId": "7fc13f97-a4bc-4619-bcf2-d00ac51778c5",
        "patientId": 23212,
        "sessionId": "",
        "consultantUserId": 6566,
        "assignedDoctorId": 5925,
        "assignedDoctorFirstName": "Serge",
        "assignedDoctorLastName": "Dyomin",
        "assignedDoctorName": "Serge Dyomin",
        "patientFirstName": "1",
        "patientLastName": "s.d.patient",
        "patientName": "1 s.d.patient",
        "dob": "1994-01-13T00:00:00Z",
        "consultationDate": "Aug 03, 2018",
        "consultationTimeInfo": "2018-08-03T07:20:37.313Z",
        "consultationTime": "07:20 AM",
        "disconnctedDuration": 0,
        "waitingConsultation": "",
        "startedConsultation": "",
        "consultationDuration": 81,
        "isDependent": false,
        "appointmentId": "e804e0e7-aae3-46ef-9108-8b3082f5ffaa",
        "dismissed": false,
        "appointmentType": 2,
        "encounterTypeCode": 2
    },
    {
        "consultationId": 39475,
        "patientPersonId": "7c011cc3-ef7f-4a68-be33-e1b65ad4f63f",
        "providerPersonId": "7fc13f97-a4bc-4619-bcf2-d00ac51778c5",
        "patientId": 23212,
        "sessionId": "",
        "consultantUserId": 6566,
        "assignedDoctorId": 5925,
        "assignedDoctorFirstName": "Serge",
        "assignedDoctorLastName": "Dyomin",
        "assignedDoctorName": "Serge Dyomin",
        "patientFirstName": "1",
        "patientLastName": "s.d.patient",
        "patientName": "1 s.d.patient",
        "dob": "1994-01-13T00:00:00Z",
        "consultationDate": "Aug 06, 2018",
        "consultationTimeInfo": "2018-08-06T03:55:28.95Z",
        "consultationTime": "03:55 AM",
        "disconnctedDuration": 0,
        "waitingConsultation": "",
        "startedConsultation": "",
        "consultationDuration": 568,
        "isDependent": false,
        "appointmentId": "c40898e4-3def-48fd-8255-3761ad4ab26c",
        "dismissed": false,
        "appointmentType": 2,
        "encounterTypeCode": 2
    }
]