GET api/v1/{EMRSystem}/Population/Encounters
Returns all Patient Encounters activity for all patients for a given date range and filtered, optionally, by a list of locations (facilities).
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| LocationList |
Gets or sets the location list. |
string |
None. |
| IncludeCareTeam |
Gets or sets a value of the getting the Patient Care Team |
boolean |
None. |
| IncludeComments |
Gets or sets a value of the getting the Comments |
boolean |
None. |
| IncludeCustomFields |
Gets or sets a value of the getting the Custom Fields |
boolean |
None. |
| UserId |
Identifier of the user initiating the request. |
string |
Required |
| FromDateTime |
Gets or sets from date time. |
datetime |
Required if EMRSystem = Cerner, or Epic, or Meditech |
| ToDateTime |
Gets or sets to date time. |
datetime |
None. |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Response Information
Collection of UdmPopulationEncounterResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| EncounterId |
Gets or sets the encounter identifier. |
string |
None. |
| EncounterType |
Gets or sets the type of the encounter. |
CodedObject |
None. |
| PatientClass |
Gets or sets the patient class. |
CodedObject |
None. |
| EncounterDateTime |
Gets or sets the encounter date time. |
datetime |
None. |
| DischargeDateTime |
Gets or sets the discharge date time. |
datetime |
None. |
| CreatedUpdatedDateTime |
Gets or sets the created updated date time. |
datetime |
None. |
| FinancialNumber |
Gets or sets the financial number. |
string |
None. |
| EncounterAlias |
Gets or sets the encounter alias. |
string |
None. |
| EncounterStatus |
Gets or sets the encounter status. |
string |
None. |
| EncounterStatusId |
Gets or sets the encounter statusId. |
string |
None. |
| AttendingProvider |
Gets or sets the attending provider. |
Provider |
None. |
| MedicalServiceId |
Gets or sets the medical serviceId. |
string |
None. |
| MedicalService |
Gets or sets the medical service. |
string |
None. |
| ReasonForVisit |
Gets or sets the reason for visit. |
string |
None. |
| AdmissionSource |
Gets or sets the admission source. |
string |
None. |
| AdmissionSourceId |
Gets or sets the admission sourceId. |
string |
None. |
| DischargeDisposition |
Gets or sets the reason for discharge disposition. |
string |
None. |
| DischargeDispositionId |
Gets or sets the reason for discharge dispositionId. |
string |
None. |
| Location |
Gets or sets the location. |
Location |
None. |
| Patient |
Gets the patient. |
BasePatient |
None. |
| PriorEncounterId |
Prior Encounter Id |
string |
None. |
| PriorFinancialNumber |
Prior Financial Number |
string |
None. |
| PatientAcuity |
Patient Acuity |
string |
None. |
| ModeOfArrival |
Mode of Arrival |
string |
None. |
| DischargeToLocation |
Location of where Discharged to |
string |
None. |
| DischargeToLocationId |
Location of where Discharged to identifier |
string |
None. |
| Isolation |
Isolation |
CodedObject |
None. |
| RegistrationDateTime |
Gets or sets the registration date time. |
datetime |
None. |
| PreRegistrationDateTime |
Gets or sets the pre-registration date time. |
datetime |
None. |
| ArrivalDateTime |
Gets or sets the arrival date time. |
datetime |
None. |
| EstimatedArrivalDateTime |
Gets or sets the estimated arrival date time. |
datetime |
None. |
| PhysicianCareTeam |
Gets or sets the Physician Care Team assigned to the encounter |
CodedObject |
None. |
| PatientCareTeam |
Gets or sets the Patient Care Team. |
Collection of PatientCareTeam |
None. |
| Comments |
Gets or sets the Comments. |
Collection of Comment |
None. |
| PatientValuables |
Gets or sets the Patient Valuables. |
Collection of CodedObject |
None. |
| CustomFields |
Gets or sets the Custom Fields. |
Collection of CustomFieldObject |
None. |
| UpdatedByUserName |
Gets or sets the Updated By User Name. |
string |
None. |
Response Codes
Http Status Code 200 - Indicates that the request was processed successfully.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
[
{
"EncounterId": "sample string 1",
"EncounterType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"EncounterDateTime": "2025-12-12T21:05:49.8206684+00:00",
"DischargeDateTime": "2025-12-12T21:05:49.8207342+00:00",
"CreatedUpdatedDateTime": "2025-12-12T21:05:49.8207723+00:00",
"FinancialNumber": "sample string 2",
"EncounterAlias": "sample string 3",
"EncounterStatus": "sample string 4",
"EncounterStatusId": "sample string 5",
"AttendingProvider": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"MedicalServiceId": "sample string 6",
"MedicalService": "sample string 7",
"ReasonForVisit": "sample string 8",
"AdmissionSource": "sample string 9",
"AdmissionSourceId": "sample string 10",
"DischargeDisposition": "sample string 11",
"DischargeDispositionId": "sample string 12",
"Location": {
"BedId": "sample string 1",
"Bed": "sample string 2",
"RoomId": "sample string 3",
"Room": "sample string 4",
"UnitId": "sample string 5",
"Unit": "sample string 6",
"HospitalId": "sample string 7",
"Hospital": "sample string 8"
},
"Patient": {
"PatientId": "sample string 1",
"DisplayName": "sample string 2",
"LastName": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"MRN": "sample string 6",
"BirthDateTime": "2025-12-12T21:05:49.8219465+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T21:05:49.821951+00:00"
},
"PriorEncounterId": "sample string 13",
"PriorFinancialNumber": "sample string 14",
"PatientAcuity": "sample string 15",
"ModeOfArrival": "sample string 16",
"DischargeToLocation": "sample string 17",
"DischargeToLocationId": "sample string 18",
"Isolation": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"RegistrationDateTime": "2025-12-12T21:05:49.8229193+00:00",
"PreRegistrationDateTime": "2025-12-12T21:05:49.8229677+00:00",
"ArrivalDateTime": "2025-12-12T21:05:49.8230044+00:00",
"EstimatedArrivalDateTime": "2025-12-12T21:05:49.8241353+00:00",
"PhysicianCareTeam": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientCareTeam": [
{
"NPI": "sample string 1",
"Provider": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"RelationshipType": "sample string 2",
"FromDate": "2025-12-12T21:05:49.8242496+00:00",
"ToDate": "2025-12-12T21:05:49.8242513+00:00",
"Phones": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T21:05:49.8242683+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T21:05:49.8242683+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"IsManuallyAdded": true,
"InternalSequence": "sample string 4"
},
{
"NPI": "sample string 1",
"Provider": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"RelationshipType": "sample string 2",
"FromDate": "2025-12-12T21:05:49.8242496+00:00",
"ToDate": "2025-12-12T21:05:49.8242513+00:00",
"Phones": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T21:05:49.8242683+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T21:05:49.8242683+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"IsManuallyAdded": true,
"InternalSequence": "sample string 4"
}
],
"Comments": [
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T21:05:49.8243308+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
},
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T21:05:49.8243308+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
}
],
"PatientValuables": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"CustomFields": [
{
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedResponseValue": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextResponseValue": [
"sample string 1",
"sample string 2"
]
},
{
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedResponseValue": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextResponseValue": [
"sample string 1",
"sample string 2"
]
}
],
"UpdatedByUserName": "2025-12-12"
},
{
"EncounterId": "sample string 1",
"EncounterType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"EncounterDateTime": "2025-12-12T21:05:49.8206684+00:00",
"DischargeDateTime": "2025-12-12T21:05:49.8207342+00:00",
"CreatedUpdatedDateTime": "2025-12-12T21:05:49.8207723+00:00",
"FinancialNumber": "sample string 2",
"EncounterAlias": "sample string 3",
"EncounterStatus": "sample string 4",
"EncounterStatusId": "sample string 5",
"AttendingProvider": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"MedicalServiceId": "sample string 6",
"MedicalService": "sample string 7",
"ReasonForVisit": "sample string 8",
"AdmissionSource": "sample string 9",
"AdmissionSourceId": "sample string 10",
"DischargeDisposition": "sample string 11",
"DischargeDispositionId": "sample string 12",
"Location": {
"BedId": "sample string 1",
"Bed": "sample string 2",
"RoomId": "sample string 3",
"Room": "sample string 4",
"UnitId": "sample string 5",
"Unit": "sample string 6",
"HospitalId": "sample string 7",
"Hospital": "sample string 8"
},
"Patient": {
"PatientId": "sample string 1",
"DisplayName": "sample string 2",
"LastName": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"MRN": "sample string 6",
"BirthDateTime": "2025-12-12T21:05:49.8219465+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T21:05:49.821951+00:00"
},
"PriorEncounterId": "sample string 13",
"PriorFinancialNumber": "sample string 14",
"PatientAcuity": "sample string 15",
"ModeOfArrival": "sample string 16",
"DischargeToLocation": "sample string 17",
"DischargeToLocationId": "sample string 18",
"Isolation": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"RegistrationDateTime": "2025-12-12T21:05:49.8229193+00:00",
"PreRegistrationDateTime": "2025-12-12T21:05:49.8229677+00:00",
"ArrivalDateTime": "2025-12-12T21:05:49.8230044+00:00",
"EstimatedArrivalDateTime": "2025-12-12T21:05:49.8241353+00:00",
"PhysicianCareTeam": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientCareTeam": [
{
"NPI": "sample string 1",
"Provider": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"RelationshipType": "sample string 2",
"FromDate": "2025-12-12T21:05:49.8242496+00:00",
"ToDate": "2025-12-12T21:05:49.8242513+00:00",
"Phones": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T21:05:49.8242683+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T21:05:49.8242683+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"IsManuallyAdded": true,
"InternalSequence": "sample string 4"
},
{
"NPI": "sample string 1",
"Provider": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"RelationshipType": "sample string 2",
"FromDate": "2025-12-12T21:05:49.8242496+00:00",
"ToDate": "2025-12-12T21:05:49.8242513+00:00",
"Phones": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T21:05:49.8242683+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"SequenceNumber": "sample string 3",
"Type": "sample string 4",
"TypeId": "sample string 5",
"Extension": "sample string 6",
"EndEffectiveDateTime": "2025-12-12T21:05:49.8242683+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"IsManuallyAdded": true,
"InternalSequence": "sample string 4"
}
],
"Comments": [
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T21:05:49.8243308+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
},
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T21:05:49.8243308+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
}
],
"PatientValuables": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"CustomFields": [
{
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedResponseValue": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextResponseValue": [
"sample string 1",
"sample string 2"
]
},
{
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedResponseValue": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextResponseValue": [
"sample string 1",
"sample string 2"
]
}
],
"UpdatedByUserName": "2025-12-12"
}
]