GET api/v1/{EMRSystem}/Population/Orders
Returns the Orders of all statuses for all patients for a given date range and filtered, optionally, by Locations (facilities) or OrderTypes.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| OrderTypes |
Gets or sets the order types. |
string |
None. |
| OrderableCodes |
Gets or sets the orderable codes. |
string |
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 UdmPopulationOrderResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId |
Gets or sets the order identifier. |
string |
None. |
| OrderableCode |
Gets or sets the orderable code. |
string |
None. |
| OrderableCodeName |
Gets or sets the orderable code name. |
string |
None. |
| OrderName |
Gets or sets the name of the order. |
string |
None. |
| OrderedDateTime |
Gets or sets the ordered date time. |
datetime |
None. |
| OrderingProviderId |
Gets or sets the ordering provider Id. |
string |
None. |
| OrderingProviderName |
Gets or sets the ordering provider name. |
string |
None. |
| OrderClinicalDisplayLineLong |
Gets or sets the order clinical display line long. |
string |
None. |
| OrderClinicalDisplayLineShort |
Gets or sets the order clinical display line short. |
string |
None. |
| OrderStatus |
Gets or sets the order status. |
string |
None. |
| OrderType |
Gets or sets the type of the order. |
string |
None. |
| OrderStartDateTime |
Gets or sets order start date time. |
datetime |
None. |
| OrderStopDateTime |
Gets or sets order stop date time. |
datetime |
None. |
| ExpectedDate |
The expected completion date of the order. |
string |
None. |
| CreatedUpdatedDateTime |
Gets or sets the created updated date time. |
datetime |
None. |
| Patient |
Gets or sets the patient. |
BasePatient |
None. |
| Encounter |
Gets or sets the encounter. |
Encounter |
None. |
| Diagnoses |
List of the order diagnoses |
Collection of OrderDiagnosis |
None. |
| OrderPriority |
The priority of the order |
CodedObject |
None. |
| OrderableCodeIdentities |
List of identifiers for the orderable |
Collection of OrderableCodeIdentity |
None. |
| Providers |
The providers associated with the order. |
Collection of PersonWithType |
None. |
| Appointments |
The appointments associated with the order. |
Collection of AppointmentCompact |
None. |
| ParentOrderId |
The parent order id |
string |
None. |
| VerifiedStatus |
Gets or sets the Verified status of Medication |
string |
None. |
| IsNurseReviewed |
Shows if the Nurse Review has been completed |
boolean |
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
[
{
"OrderId": "sample string 1",
"OrderableCode": "sample string 2",
"OrderableCodeName": "sample string 3",
"OrderName": "sample string 4",
"OrderedDateTime": "2025-12-12T20:55:16.6065137+00:00",
"OrderingProviderId": "sample string 5",
"OrderingProviderName": "sample string 6",
"OrderClinicalDisplayLineLong": "sample string 7",
"OrderClinicalDisplayLineShort": "sample string 8",
"OrderStatus": "sample string 9",
"OrderType": "sample string 10",
"OrderStartDateTime": "2025-12-12T20:55:16.6067547+00:00",
"OrderStopDateTime": "2025-12-12T20:55:16.6067913+00:00",
"ExpectedDate": "2025-12-12",
"CreatedUpdatedDateTime": "2025-12-12T20:55:16.6068806+00:00",
"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-12T20:55:16.6091365+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T20:55:16.6091515+00:00"
},
"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-12T20:55:16.6092361+00:00",
"DischargeDateTime": "2025-12-12T20:55:16.6092378+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"
}
},
"Diagnoses": [
{
"DiagnosisName": "sample string 1",
"DiagnosisText": "sample string 2",
"Codes": [
{
"CodeSet": "sample string 1",
"Code": "sample string 2",
"Description": "sample string 3"
},
{
"CodeSet": "sample string 1",
"Code": "sample string 2",
"Description": "sample string 3"
}
],
"Comment": "sample string 3",
"Qualifier": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"DiagnosisName": "sample string 1",
"DiagnosisText": "sample string 2",
"Codes": [
{
"CodeSet": "sample string 1",
"Code": "sample string 2",
"Description": "sample string 3"
},
{
"CodeSet": "sample string 1",
"Code": "sample string 2",
"Description": "sample string 3"
}
],
"Comment": "sample string 3",
"Qualifier": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"OrderPriority": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OrderableCodeIdentities": [
{
"Value": "sample string 1",
"Type": "sample string 2"
},
{
"Value": "sample string 1",
"Type": "sample string 2"
}
],
"Providers": [
{
"Name": "sample string 1",
"NPI": "sample string 2",
"UserId": "sample string 3",
"ProviderId": "sample string 4",
"Type": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"Name": "sample string 1",
"NPI": "sample string 2",
"UserId": "sample string 3",
"ProviderId": "sample string 4",
"Type": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"Appointments": [
{
"AppointmentId": "sample string 1",
"AppointmentDateTime": "2025-12-12T20:55:16.6162945+00:00",
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"AppointmentId": "sample string 1",
"AppointmentDateTime": "2025-12-12T20:55:16.6162945+00:00",
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"ParentOrderId": "sample string 11",
"VerifiedStatus": "sample string 12",
"IsNurseReviewed": true
},
{
"OrderId": "sample string 1",
"OrderableCode": "sample string 2",
"OrderableCodeName": "sample string 3",
"OrderName": "sample string 4",
"OrderedDateTime": "2025-12-12T20:55:16.6065137+00:00",
"OrderingProviderId": "sample string 5",
"OrderingProviderName": "sample string 6",
"OrderClinicalDisplayLineLong": "sample string 7",
"OrderClinicalDisplayLineShort": "sample string 8",
"OrderStatus": "sample string 9",
"OrderType": "sample string 10",
"OrderStartDateTime": "2025-12-12T20:55:16.6067547+00:00",
"OrderStopDateTime": "2025-12-12T20:55:16.6067913+00:00",
"ExpectedDate": "2025-12-12",
"CreatedUpdatedDateTime": "2025-12-12T20:55:16.6068806+00:00",
"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-12T20:55:16.6091365+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T20:55:16.6091515+00:00"
},
"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-12T20:55:16.6092361+00:00",
"DischargeDateTime": "2025-12-12T20:55:16.6092378+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"
}
},
"Diagnoses": [
{
"DiagnosisName": "sample string 1",
"DiagnosisText": "sample string 2",
"Codes": [
{
"CodeSet": "sample string 1",
"Code": "sample string 2",
"Description": "sample string 3"
},
{
"CodeSet": "sample string 1",
"Code": "sample string 2",
"Description": "sample string 3"
}
],
"Comment": "sample string 3",
"Qualifier": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"DiagnosisName": "sample string 1",
"DiagnosisText": "sample string 2",
"Codes": [
{
"CodeSet": "sample string 1",
"Code": "sample string 2",
"Description": "sample string 3"
},
{
"CodeSet": "sample string 1",
"Code": "sample string 2",
"Description": "sample string 3"
}
],
"Comment": "sample string 3",
"Qualifier": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"OrderPriority": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OrderableCodeIdentities": [
{
"Value": "sample string 1",
"Type": "sample string 2"
},
{
"Value": "sample string 1",
"Type": "sample string 2"
}
],
"Providers": [
{
"Name": "sample string 1",
"NPI": "sample string 2",
"UserId": "sample string 3",
"ProviderId": "sample string 4",
"Type": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"Name": "sample string 1",
"NPI": "sample string 2",
"UserId": "sample string 3",
"ProviderId": "sample string 4",
"Type": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"Appointments": [
{
"AppointmentId": "sample string 1",
"AppointmentDateTime": "2025-12-12T20:55:16.6162945+00:00",
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"AppointmentId": "sample string 1",
"AppointmentDateTime": "2025-12-12T20:55:16.6162945+00:00",
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"ParentOrderId": "sample string 11",
"VerifiedStatus": "sample string 12",
"IsNurseReviewed": true
}
]