POST api/v1/{EMRSystem}/MedicationAdministrations/ContinuousIV
Creates a Continuous IV Medication Administration.
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmContinuousIVMedicationAdministrationCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| IVEvent |
The type of IV Event to document - BeginBag, Infuse, Bolus, Waste, SiteChange, RateChange |
IVEvent |
Required |
| UserId |
The identifier of the user creating the medication administration. |
string |
Required |
| PatientId |
The identifier of the patient. |
string |
Required |
| PatientIdType |
The identifier of the patient type. |
string |
None. |
| OrderId |
The identifier of the order. |
string |
Required |
| ScheduledAdministrationId |
The identifier of the scheduled administration. |
string |
Required if EMRSystem = Cerner |
| IsPatientBandScanned |
The flag stating the patient band barcode was scanned. |
boolean |
Required |
| PatientNotScannedReason |
The reason the patient band was not scanned. |
string |
None. |
| IsMedicationScanned |
The flag stating the medication barcode was scanned. |
boolean |
Required |
| MedicationNotScannedReason |
The reason the medication barcode was not scanned. |
string |
None. |
| MedicationBarcode |
The medication barcode of the drug being administered |
string |
None. |
| AdministrationClinicianId |
The identifier of the administration clinician. |
string |
None. |
| WitnessId |
The Id of the Witness of the Administration |
string |
None. |
| AdministrationStartDateTime |
The date and time of the medication administration. |
string |
None. |
| AdministrationEndDateTime |
The date and time of the medication administration. |
string |
None. |
| DocumentedDateTime |
The date and time the administration was documented. |
string |
None. |
| BagNumber |
The bag/lot number of the IV medication |
string |
Required if EMRSystem = Cerner |
| Volume |
The volume of the administration. |
string |
None. |
| VolumeUnitId |
The identifier of the volume unit. |
string |
None. |
| AdministrationSiteId |
The identifier of the administration site. |
string |
None. |
| Rate |
The rate of the administration. |
string |
None. |
| RateUnitId |
The identifier of the rate unit. |
string |
None. |
| Comments |
The administration comments. |
string |
None. |
| SystemId |
The identifier of the system |
string |
None. |
| ReferenceNumber |
The unique reference number for the transaction |
string |
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. |
Request Formats
application/json
{
"IVEvent": 1,
"UserId": "sample string 1",
"PatientId": "sample string 2",
"PatientIdType": "sample string 3",
"OrderId": "sample string 4",
"ScheduledAdministrationId": "sample string 5",
"IsPatientBandScanned": true,
"PatientNotScannedReason": "sample string 7",
"IsMedicationScanned": true,
"MedicationNotScannedReason": "sample string 9",
"MedicationBarcode": "sample string 10",
"AdministrationClinicianId": "sample string 11",
"WitnessId": "sample string 12",
"AdministrationStartDateTime": "2025-12-12",
"AdministrationEndDateTime": "2025-12-12",
"DocumentedDateTime": "2025-12-12",
"BagNumber": "sample string 13",
"Volume": "sample string 14",
"VolumeUnitId": "sample string 15",
"AdministrationSiteId": "sample string 16",
"Rate": "sample string 17",
"RateUnitId": "sample string 18",
"Comments": "sample string 19",
"SystemId": "sample string 20",
"ReferenceNumber": "sample string 21",
"LoginId": "sample string 23",
"Password": "sample string 24",
"EmrInstance": "sample string 25",
"ApplicationName": "sample string 26",
"ApplicationKey": null,
"AuthorizationToken": "sample string 28",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmContinuousIVMedicationAdministrationCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| AdministrationId |
The identifier of the administration that was created. |
string |
None. |
Response Codes
Http Status Code 201 - 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"
}