POST api/v1/{EMRSystem}/MedicationAdministrations/Adhoc
Creates an AdHoc Medication Administration.
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmAdHocMedicationAdministrationCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
The identifier of the user creating the medication administration. |
string |
Required |
| EncounterId |
The identifier of the Encounter. |
string |
Required |
| MedicationId |
The Medication Id |
string |
Required |
| MedicationItemId |
The Medication Item Id |
string |
Required if EMRSystem = Cerner |
| CommunicationTypeId |
The Communtication type ID |
string |
Required |
| OrderingProviderId |
The Ordering Provider |
string |
Required |
| WitnessId |
The Witness of Med Admin |
string |
None. |
| Dose |
The dose of the administration. |
string |
None. |
| DoseUnitId |
The identifier of the dose unit. |
string |
None. |
| Volume |
The volume of the administration. |
string |
None. |
| VolumeUnitId |
The identifier of the volume unit. |
string |
None. |
| AdministrationRouteId |
The identifier of administration route. |
string |
None. |
| AdministrationSiteId |
The identifier of the administration site. |
string |
None. |
| DocumentedDateTime |
The date and time the administration was documented. |
string |
None. |
| Comments |
The administration comments. |
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
{
"UserId": "sample string 1",
"EncounterId": "sample string 2",
"MedicationId": "sample string 3",
"MedicationItemId": "sample string 4",
"CommunicationTypeId": "sample string 5",
"OrderingProviderId": "sample string 6",
"WitnessId": "sample string 7",
"Dose": "sample string 8",
"DoseUnitId": "sample string 9",
"Volume": "sample string 10",
"VolumeUnitId": "sample string 11",
"AdministrationRouteId": "sample string 12",
"AdministrationSiteId": "sample string 13",
"DocumentedDateTime": "2025-12-12",
"Comments": "sample string 14",
"LoginId": "sample string 16",
"Password": "sample string 17",
"EmrInstance": "sample string 18",
"ApplicationName": "sample string 19",
"ApplicationKey": null,
"AuthorizationToken": "sample string 21",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmAdHocMedicationAdministrationCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId |
The identifier of the Order that was created. |
string |
None. |
| 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
{
"OrderId": "sample string 1",
"AdministrationId": "sample string 2"
}