POST api/v1/{EMRSystem}/MedicationOrders
Creates a historical Medication Order.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmMedicationOrderCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
The identifier of the user creating the medication order. |
string |
Required |
| PatientId |
The identifier of the patient. |
string |
Required |
| EncounterId |
Identifier of the encounter to add the medication order to. |
string |
Required if EMRSystem = Epic, or Cerner |
| MedicationId |
The identifier of the medication. |
string |
Required |
| AdminInstructions |
The free text instructions for taking the medication. |
string |
Required |
| ProviderId |
The identifier of the authorizing provider |
string |
None. |
| StartDateTime |
The date the medication was started |
datetime |
None. |
| StopDateTime |
The date the medication was stopped |
datetime |
None. |
| MedicationComments |
Additional medication information |
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",
"PatientId": "sample string 2",
"EncounterId": "sample string 3",
"MedicationId": "sample string 4",
"AdminInstructions": "sample string 5",
"ProviderId": "sample string 6",
"StartDateTime": "2025-12-12T21:08:38.5636159+00:00",
"StopDateTime": "2025-12-12T21:08:38.5637215+00:00",
"MedicationComments": "sample string 7",
"LoginId": "sample string 9",
"Password": "sample string 10",
"EmrInstance": "sample string 11",
"ApplicationName": "sample string 12",
"ApplicationKey": null,
"AuthorizationToken": "sample string 14",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmMedicationOrderCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| MedicationOrderId |
The identifier of the medication order 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
{
"MedicationOrderId": "sample string 1"
}