GET api/v1/{EMRSystem}/Population/MedicationOrderDispenses
Returns the Medication Orders of all statuses for all patients for a given date range and filtered, optionally, by Locations (facilities) or VerifiedStatus (e.g. Verified or All). Additionally, flags are available for the inclusion of NDC or RxNorm values.
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 UdmPopulationMedicationDispensesResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| CreatedUpdatedDateTime |
Gets or sets the created updated date time. |
datetime |
None. |
| MedicationOrderId |
Gets or sets the medication order identifier. |
string |
None. |
| DispenseHistory |
Gets or sets the dispense history of the medication |
Collection of DispenseHistory |
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
[
{
"CreatedUpdatedDateTime": "2025-12-12T21:08:47.6532597+00:00",
"MedicationOrderId": "sample string 1",
"DispenseHistory": [
{
"DispenseId": "sample string 1",
"DispenseDateTime": "2025-12-12T21:08:47.6533915+00:00",
"DispenseEventType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"DispenseId": "sample string 1",
"DispenseDateTime": "2025-12-12T21:08:47.6533915+00:00",
"DispenseEventType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
]
},
{
"CreatedUpdatedDateTime": "2025-12-12T21:08:47.6532597+00:00",
"MedicationOrderId": "sample string 1",
"DispenseHistory": [
{
"DispenseId": "sample string 1",
"DispenseDateTime": "2025-12-12T21:08:47.6533915+00:00",
"DispenseEventType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"DispenseId": "sample string 1",
"DispenseDateTime": "2025-12-12T21:08:47.6533915+00:00",
"DispenseEventType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
]
}
]