GET api/v1/{EMRSystem}/Population/Appointments
Returns the Appointments for all patients for a given date range and filtered, optionally, by Locations (facilities) or Status.
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| LocationList |
Gets or sets the location list. |
string |
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 UdmPopulationAppointmentsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| AppointmentId |
Gets or sets the appointment identifier. |
string |
None. |
| AppointmentComments |
Gets or sets the appointment comments. |
string |
None. |
| AppointmentDateTime |
Gets or sets the appointment date time. |
datetime |
None. |
| AppointmentDetails |
Gets or sets the appointment detail. |
Collection of AppointmentDetail |
None. |
| ConfirmedDateTime |
Gets or sets confirmed date time. |
datetime |
None. |
| Copay |
Gets or sets the copay. |
string |
None. |
| CreatedUpdatedDateTime |
Gets or sets the created updated date time. |
datetime |
None. |
| Duration |
Gets or sets the appointment duration |
Duration |
None. |
| Encounter |
Gets or sets the encounter. |
Encounter |
None. |
| Patient |
Gets or sets the patient. |
BasePatient |
None. |
| IsRecurring |
Gets or sets whether the appointment is recurring. |
boolean |
None. |
| OrderId |
Gets or sets the order identifier. |
string |
None. |
| ResourceDepartments |
Gets or sets the resource departments. |
Collection of ResourceDepartment |
None. |
| Status |
The appointment status |
CodedObject |
None. |
| VisitType |
The visit type |
VisitType |
None. |
| AppointmentActions |
The AppointActions |
Collection of AppointmentAction |
None. |
| VisitReason |
Gets or sets the visit reason. |
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
[
{
"AppointmentId": "sample string 1",
"AppointmentComments": "sample string 2",
"AppointmentDateTime": "2025-12-12T21:06:40.4621468+00:00",
"AppointmentDetails": [
{
"FieldId": "sample string 1",
"Response": "sample string 2"
},
{
"FieldId": "sample string 1",
"Response": "sample string 2"
}
],
"ConfirmedDateTime": "2025-12-12T21:06:40.4625959+00:00",
"Copay": "sample string 3",
"CreatedUpdatedDateTime": "2025-12-12T21:06:40.4626716+00:00",
"Duration": {
"DurationUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Time": "sample string 1"
},
"Encounter": {
"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:06:40.4628316+00:00",
"DischargeDateTime": "2025-12-12T21:06:40.4628336+00:00",
"FinancialNumber": "sample string 2",
"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:06:40.4628923+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T21:06:40.4628947+00:00"
},
"IsRecurring": true,
"OrderId": "sample string 5",
"ResourceDepartments": [
{
"Department": {
"ExternalName": "sample string 1",
"Specialty": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Address": {
"AddressId": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"ZIP": "sample string 7",
"Type": "sample string 8",
"TypeId": "sample string 9",
"SequenceNumber": "sample string 10",
"Country": "sample string 11",
"County": "sample string 12",
"EndEffectiveDateTime": "2025-12-12T21:06:40.4632717+00:00"
},
"PhoneNumbers": [
{
"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:06:40.4633658+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:06:40.4633658+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"DrivingDirections": [
"sample string 1",
"sample string 2"
],
"DepartmentId": "sample string 2",
"DepartmentName": "sample string 3"
},
"Resource": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2",
"URLs": [
{
"Type": "sample string 1",
"URL": "sample string 2"
},
{
"Type": "sample string 1",
"URL": "sample string 2"
}
]
}
},
{
"Department": {
"ExternalName": "sample string 1",
"Specialty": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Address": {
"AddressId": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"ZIP": "sample string 7",
"Type": "sample string 8",
"TypeId": "sample string 9",
"SequenceNumber": "sample string 10",
"Country": "sample string 11",
"County": "sample string 12",
"EndEffectiveDateTime": "2025-12-12T21:06:40.4632717+00:00"
},
"PhoneNumbers": [
{
"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:06:40.4633658+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:06:40.4633658+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"DrivingDirections": [
"sample string 1",
"sample string 2"
],
"DepartmentId": "sample string 2",
"DepartmentName": "sample string 3"
},
"Resource": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2",
"URLs": [
{
"Type": "sample string 1",
"URL": "sample string 2"
},
{
"Type": "sample string 1",
"URL": "sample string 2"
}
]
}
}
],
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"VisitType": {
"ExternalName": "sample string 1",
"VisitTypeId": "sample string 2",
"VisitTypeName": "sample string 3"
},
"AppointmentActions": [
{
"Action": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Resource": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ActionReason": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ActionPerformedBy": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"ActionDateTime": "2025-12-12T21:06:40.46483+00:00",
"AppointmentDateTime": "2025-12-12T21:06:40.4649178+00:00"
},
{
"Action": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Resource": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ActionReason": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ActionPerformedBy": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"ActionDateTime": "2025-12-12T21:06:40.46483+00:00",
"AppointmentDateTime": "2025-12-12T21:06:40.4649178+00:00"
}
],
"VisitReason": "sample string 6"
},
{
"AppointmentId": "sample string 1",
"AppointmentComments": "sample string 2",
"AppointmentDateTime": "2025-12-12T21:06:40.4621468+00:00",
"AppointmentDetails": [
{
"FieldId": "sample string 1",
"Response": "sample string 2"
},
{
"FieldId": "sample string 1",
"Response": "sample string 2"
}
],
"ConfirmedDateTime": "2025-12-12T21:06:40.4625959+00:00",
"Copay": "sample string 3",
"CreatedUpdatedDateTime": "2025-12-12T21:06:40.4626716+00:00",
"Duration": {
"DurationUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Time": "sample string 1"
},
"Encounter": {
"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:06:40.4628316+00:00",
"DischargeDateTime": "2025-12-12T21:06:40.4628336+00:00",
"FinancialNumber": "sample string 2",
"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:06:40.4628923+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T21:06:40.4628947+00:00"
},
"IsRecurring": true,
"OrderId": "sample string 5",
"ResourceDepartments": [
{
"Department": {
"ExternalName": "sample string 1",
"Specialty": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Address": {
"AddressId": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"ZIP": "sample string 7",
"Type": "sample string 8",
"TypeId": "sample string 9",
"SequenceNumber": "sample string 10",
"Country": "sample string 11",
"County": "sample string 12",
"EndEffectiveDateTime": "2025-12-12T21:06:40.4632717+00:00"
},
"PhoneNumbers": [
{
"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:06:40.4633658+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:06:40.4633658+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"DrivingDirections": [
"sample string 1",
"sample string 2"
],
"DepartmentId": "sample string 2",
"DepartmentName": "sample string 3"
},
"Resource": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2",
"URLs": [
{
"Type": "sample string 1",
"URL": "sample string 2"
},
{
"Type": "sample string 1",
"URL": "sample string 2"
}
]
}
},
{
"Department": {
"ExternalName": "sample string 1",
"Specialty": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Address": {
"AddressId": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"ZIP": "sample string 7",
"Type": "sample string 8",
"TypeId": "sample string 9",
"SequenceNumber": "sample string 10",
"Country": "sample string 11",
"County": "sample string 12",
"EndEffectiveDateTime": "2025-12-12T21:06:40.4632717+00:00"
},
"PhoneNumbers": [
{
"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:06:40.4633658+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:06:40.4633658+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"DrivingDirections": [
"sample string 1",
"sample string 2"
],
"DepartmentId": "sample string 2",
"DepartmentName": "sample string 3"
},
"Resource": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2",
"URLs": [
{
"Type": "sample string 1",
"URL": "sample string 2"
},
{
"Type": "sample string 1",
"URL": "sample string 2"
}
]
}
}
],
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"VisitType": {
"ExternalName": "sample string 1",
"VisitTypeId": "sample string 2",
"VisitTypeName": "sample string 3"
},
"AppointmentActions": [
{
"Action": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Resource": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ActionReason": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ActionPerformedBy": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"ActionDateTime": "2025-12-12T21:06:40.46483+00:00",
"AppointmentDateTime": "2025-12-12T21:06:40.4649178+00:00"
},
{
"Action": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Resource": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ActionReason": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ActionPerformedBy": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"ActionDateTime": "2025-12-12T21:06:40.46483+00:00",
"AppointmentDateTime": "2025-12-12T21:06:40.4649178+00:00"
}
],
"VisitReason": "sample string 6"
}
]