API changes for release 3.4

List visits

GET https://{host}/api/v3.1/admin/visits?{parameters}

GET https://{host}/api/v3.1/admin/clinicians?{parameters}

GET https://{host}/api/v3.1/admin/patients?{parameters}

GET https://{host}/api/v3.1/admin/caregivers?{parameters}

Summary

Get a list of visits (both appointments and consultations) filtered by some conditions.

Those 4 methods are very similar and differ slightly in parameters and access permissions.

URL parameters

Name	Values	Comment	Applicability
startTime, endTime	DateTime range	Consultation or appointment start time range. Null means no constraints.
patientId	Id of patient's profile or null	If not null, only that patient's visits are returned.	For patients this may be either current patient id, authorized dependent id or null (which means patients themselves and all their authorized dependents).
physicianUserId	User id of a provider or null	If not null, only that provider's visits are returned.	For clinician requests, this can be only current user id or null (which implicitly means current user id).
visitStatuses	string[] (see below)	Only visits with those statuses are included into response.
excludeVisitStatuses	string[] (see below)	Visits with those statuses are excluded from response, even if they should be included according to visitStatuses parameter.
patientOrPhysicianNameFilter	string	This string should be present either in patient or provider name.
sortOrderFields	[{ name: ('date', 'patient' or 'provider'), direction: (1-ascending or 2-descending) }]	Array of fields for sorting. Only visit date, patient or provider names are accepted.
skip, take	int	Response paging parameters.	default values are (0, 20)

Patient presenter API (.../caregivers) returns only visits of patients, visible by current user according to visibility rules.

Each visit has a set of assigned statuses (one or more).

Status name	Meaning
Ended	Visit was ended normally.
Unresolved	Visit was missed, interrupted etc. Also cancelled visits with "hanging" payment are considered unresolved.
DNA	Visit was missed by patient.
ProviderDNA	Visit was missed by provider.
Dropped
Dismissed
Cancelled
Active	Visit in progress
CommunicationEnded	Provider ended communication with patient, but not yet completed all related actions.
Scheduled	Visit is scheduled for the future (or not later then 30 minutes before now)
NoteOpen	Provider is still able to edit SOAP notes for the visit.

Those status values are used as a filter in visitStatuses and excludeVisitStatuses parameters and are returned in response.

Response

Property	Type	Meaning
visitStatuses	string[] (see table above)	List of statuses attached to the visit. List contains all statuses, even if they do not match filter (visitStatuses URL parameter).
visitStatus	string (see table above)	One of the statuses from visitStatuses list, most suitable to be displayed in UI. May have "None" value, if visitStatuses list is empty.
encounterNoteLockedTime	datetime	The time when consultation SOAP notes were locked from editing (or will be locked, if they are still open). Legal for "Ended" and "Unresolved" statuses.
shouldChangeNoteStatus	bool	Should UI provide dialog for changing open/closed status for SOAP notes?
appointmentId	guid	Id (primary key) of the appointment record.
appointmentStatusCode	AppointmentStatusCode
appointmentTypeCode	AppointmentTypeCode
serviceType.id	int	Internal numeric id of service type.
serviceType.description	string	Service type name.
encounterTypeCode	EncounterTypeCode
appointmentStartTime, appointmentEndTime	datetime	Scheduled start/end appointment time (time slot).
appointmentCancelReasonId	int
consultationId	int	Id (primary key) of the consultation record.
consultationStatus	ConsultationStatusCode
consultationTime	datetime	Actual time of consultation start.
consultationDuration	int	Consultation duration in minutes.
provider.personId	guid	Provider participant data.
provider.firstName	string
provider.lastName	string
provider.userId	int
patient.personId	guid	Patient participant data.
patient.firstName	string
patient.lastName	string
patient.userId	int
timeZoneName, timeZoneAbbreviation	string	Standard Windows time zone name and abbreviation for current user (user sending a request).