Get all Encounter Records with related data by user ID

GET {{url}}/{{tenantName}}/{{instanceName}}/users/:userId/full-encounters

HTTP Request

GET /{tenantName}/{instanceName}/users/{userId}/full-encounters

in our example it would be:

GET https://api.live.welkincloud.io/gh/sb-demo/users/f5b84d92-7989-45f4-bb5f-d85336c8e4b6/full-encounters

Responses

CodeDescription
200OK
401Unauthorized
403Forbidden
404Not Found

Request Params

KeyDatatypeRequiredDescription
filtersstring
onlyWithCalendarEventbooleanExclude all information not related to calendar event, except encounter record
calendarEventFromstring
calendarEventTostring
createdBystring
withCareTeambooleanIf true, return only encounter thats belong to the patients in the user care team (default: true)
statusesnullEncounter status. Available statuses: DRAFT,OPEN,ACTIVE,FINALIZED
pagenullPagination: page number
sizenullPagination: page size
sortnullSort field with sorting order(asc or desc) after coma