GET api/v1/{EMRSystem}/Population/MedicationAdmins
Returns all Medication Administrations of all statuses for all patients for a given date range and filtered, optionally, by Medications (list) or locations (facilities). Additionally, flags are available for the inclusion of NDC or RxNorm values.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| MedicationList |
Gets or sets the medication list. |
string |
None. |
| IncludeRxNorm |
Gets or sets a value indicating whether [include rx norm]. |
boolean |
None. |
| IncludeNDC |
Gets or sets a value indicating whether [include NDC]. |
boolean |
None. |
| LocationList |
Gets or sets the location list. |
string |
None. |
| IncludeTasks |
Gets or sets a value indicating whether [include Tasks]. |
boolean |
None. |
| IVEventList |
Gets or sets the IV event 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 UdmPopulationMedicationAdministrationResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| AdministrationId |
Gets or sets the administration identifier. |
string |
None. |
| AdministrationAction |
Gets or sets the administration action. |
string |
None. |
| AdministrationClinician |
Gets or sets the administration clinician. |
Provider |
None. |
| AdministrationDateTime |
Gets or sets the administration date time. |
datetime |
None. |
| AdministrationStatus |
Gets the administration status. |
string |
None. |
| AdministrationRoute |
Gets the administration route. |
string |
None. |
| AdministrationSite |
Gets the administration site. |
CodedObject |
None. |
| AdministrationLocation |
Gets or sets the administration location. |
string |
None. |
| AdministrationNotes |
Gets or sets the administration notes. |
string |
None. |
| CreatedUpdatedDateTime |
Gets the created updated date time. |
datetime |
None. |
| DocumentedDateTime |
Gets or sets the documented date time. |
datetime |
None. |
| Dose |
Gets or sets the dose. |
string |
None. |
| DoseUnit |
Gets or sets the dose unit. |
string |
None. |
| DoseDuration |
Gets or sets the duration of the dose. |
string |
None. |
| DoseDurationUnit |
Gets or sets the duration unit of the dose. |
string |
None. |
| Rate |
Gets or sets the rate. |
string |
None. |
| RateUnit |
Gets or sets the rate unit. |
string |
None. |
| IVEvent |
Gets or sets the IV event. |
CodedObject |
None. |
| InitialVolume |
Gets or sets the initial volume. |
string |
None. |
| InitialVolumeUnit |
Gets or sets the initial volume unit. |
CodedObject |
None. |
| BagNumber |
Gets or sets the bag number. |
string |
None. |
| Order |
Gets or sets the order. |
BaseMedicationOrder |
None. |
| Patient |
Gets or sets the patient. |
BasePatient |
None. |
| Encounter |
Gets or sets the encounter. |
Encounter |
None. |
| TaskClass |
The Task Activity Class (Depricated) |
CodedObjectDescription |
None. |
| Tasks |
Gets or sets the List of Tasks |
Collection of TaskObject |
None. |
| DispenseHistory |
Gets or sets the dispense history of the medication |
Collection of DispenseHistory |
None. |
| System |
Gets or sets the contributing System and its id and name |
CodedObject |
None. |
| IsPatientBandScanned |
Gets or sets the boolean if the Patient was scanned |
boolean |
None. |
| IsMedicationScanned |
Gets or sets the boolean if the Medication was scanned |
boolean |
None. |
| ParentAdministrationId |
Gets or sets the Parent Administration Id |
string |
None. |
| AdministeredIngredientId |
Gets or sets the Administered IngredientId. |
string |
None. |
| ResultStatus |
Gets or sets the Result Status. |
CodedObject |
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
[
{
"AdministrationId": "sample string 1",
"AdministrationAction": "sample string 2",
"AdministrationClinician": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"AdministrationDateTime": "2025-12-12T21:07:19.1472273+00:00",
"AdministrationStatus": "sample string 3",
"AdministrationRoute": "sample string 4",
"AdministrationSite": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"AdministrationLocation": "sample string 5",
"AdministrationNotes": "sample string 6",
"CreatedUpdatedDateTime": "2025-12-12T21:07:19.1475036+00:00",
"DocumentedDateTime": "2025-12-12T21:07:19.1476517+00:00",
"Dose": "sample string 7",
"DoseUnit": "sample string 8",
"DoseDuration": "sample string 9",
"DoseDurationUnit": "sample string 10",
"Rate": "sample string 11",
"RateUnit": "sample string 12",
"IVEvent": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"InitialVolume": "sample string 13",
"InitialVolumeUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"BagNumber": "sample string 14",
"Order": {
"MedicationOrderId": "sample string 1",
"MedicationOrderPriority": "sample string 2",
"MedicationOrderExternalId": "sample string 3",
"MedicationId": "sample string 4",
"MedicationName": "sample string 5",
"MedicationGenericName": "sample string 6",
"MedicationItemId": "sample string 7",
"MedicationOrderStatus": "sample string 8",
"MedicationOrderingProvider": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"NDC": "sample string 9",
"RxNorms": [
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
},
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
}
],
"Ingredients": [
{
"IngredientItemId": "sample string 1",
"AHFS": [
"sample string 1",
"sample string 2"
],
"IngredientId": "sample string 2",
"IngredientName": "sample string 3",
"IngredientRxNorms": [
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
},
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
}
],
"NDC": "sample string 4",
"Dose": "sample string 5",
"DoseUnit": "sample string 6",
"Strength": "sample string 7",
"StrengthUnit": "sample string 8",
"StrengthDose": "sample string 9",
"StrengthDoseUnit": "sample string 10",
"IngredientType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"IngredientItemId": "sample string 1",
"AHFS": [
"sample string 1",
"sample string 2"
],
"IngredientId": "sample string 2",
"IngredientName": "sample string 3",
"IngredientRxNorms": [
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
},
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
}
],
"NDC": "sample string 4",
"Dose": "sample string 5",
"DoseUnit": "sample string 6",
"Strength": "sample string 7",
"StrengthUnit": "sample string 8",
"StrengthDose": "sample string 9",
"StrengthDoseUnit": "sample string 10",
"IngredientType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"ParentOrderId": "sample string 10",
"OrderableCode": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
"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:07:19.1483253+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T21:07:19.1483288+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-12T21:07:19.1484048+00:00",
"DischargeDateTime": "2025-12-12T21:07:19.1484065+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"
}
},
"TaskClass": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
},
"Tasks": [
{
"TaskId": "sample string 1",
"TaskClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"TaskId": "sample string 1",
"TaskClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"DispenseHistory": [
{
"DispenseId": "sample string 1",
"DispenseDateTime": "2025-12-12T21:07:19.1488203+00:00",
"DispenseEventType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"DispenseId": "sample string 1",
"DispenseDateTime": "2025-12-12T21:07:19.1488203+00:00",
"DispenseEventType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"System": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"IsPatientBandScanned": true,
"IsMedicationScanned": true,
"ParentAdministrationId": "sample string 15",
"AdministeredIngredientId": "sample string 16",
"ResultStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"AdministrationId": "sample string 1",
"AdministrationAction": "sample string 2",
"AdministrationClinician": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"AdministrationDateTime": "2025-12-12T21:07:19.1472273+00:00",
"AdministrationStatus": "sample string 3",
"AdministrationRoute": "sample string 4",
"AdministrationSite": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"AdministrationLocation": "sample string 5",
"AdministrationNotes": "sample string 6",
"CreatedUpdatedDateTime": "2025-12-12T21:07:19.1475036+00:00",
"DocumentedDateTime": "2025-12-12T21:07:19.1476517+00:00",
"Dose": "sample string 7",
"DoseUnit": "sample string 8",
"DoseDuration": "sample string 9",
"DoseDurationUnit": "sample string 10",
"Rate": "sample string 11",
"RateUnit": "sample string 12",
"IVEvent": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"InitialVolume": "sample string 13",
"InitialVolumeUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"BagNumber": "sample string 14",
"Order": {
"MedicationOrderId": "sample string 1",
"MedicationOrderPriority": "sample string 2",
"MedicationOrderExternalId": "sample string 3",
"MedicationId": "sample string 4",
"MedicationName": "sample string 5",
"MedicationGenericName": "sample string 6",
"MedicationItemId": "sample string 7",
"MedicationOrderStatus": "sample string 8",
"MedicationOrderingProvider": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"NDC": "sample string 9",
"RxNorms": [
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
},
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
}
],
"Ingredients": [
{
"IngredientItemId": "sample string 1",
"AHFS": [
"sample string 1",
"sample string 2"
],
"IngredientId": "sample string 2",
"IngredientName": "sample string 3",
"IngredientRxNorms": [
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
},
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
}
],
"NDC": "sample string 4",
"Dose": "sample string 5",
"DoseUnit": "sample string 6",
"Strength": "sample string 7",
"StrengthUnit": "sample string 8",
"StrengthDose": "sample string 9",
"StrengthDoseUnit": "sample string 10",
"IngredientType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"IngredientItemId": "sample string 1",
"AHFS": [
"sample string 1",
"sample string 2"
],
"IngredientId": "sample string 2",
"IngredientName": "sample string 3",
"IngredientRxNorms": [
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
},
{
"Code": "sample string 1",
"CodeType": "sample string 2",
"TermType": "sample string 3"
}
],
"NDC": "sample string 4",
"Dose": "sample string 5",
"DoseUnit": "sample string 6",
"Strength": "sample string 7",
"StrengthUnit": "sample string 8",
"StrengthDose": "sample string 9",
"StrengthDoseUnit": "sample string 10",
"IngredientType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"ParentOrderId": "sample string 10",
"OrderableCode": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
"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:07:19.1483253+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T21:07:19.1483288+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-12T21:07:19.1484048+00:00",
"DischargeDateTime": "2025-12-12T21:07:19.1484065+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"
}
},
"TaskClass": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
},
"Tasks": [
{
"TaskId": "sample string 1",
"TaskClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"TaskId": "sample string 1",
"TaskClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"DispenseHistory": [
{
"DispenseId": "sample string 1",
"DispenseDateTime": "2025-12-12T21:07:19.1488203+00:00",
"DispenseEventType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"DispenseId": "sample string 1",
"DispenseDateTime": "2025-12-12T21:07:19.1488203+00:00",
"DispenseEventType": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"System": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"IsPatientBandScanned": true,
"IsMedicationScanned": true,
"ParentAdministrationId": "sample string 15",
"AdministeredIngredientId": "sample string 16",
"ResultStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
]