POST api/v1/{EMRSystem}/ProposedOrders
Creates a new Proposed Order
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmProposedOrderCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Gets or sets the user identifier. |
string |
Required |
| PatientId |
Gets or sets the patient identifier. |
string |
Required if EMRSystem = Cerner |
| PatientIdType |
Gets or sets the patient identifier type. |
string |
None. |
| EncounterId |
Gets or sets the encounter identifier. |
string |
Required |
| EncounterIdType |
Gets or sets the encounter identifier type. |
string |
None. |
| OrderableCodeId |
Gets or sets the orderablecode identifier. |
string |
Required if EMRSystem = Cerner |
| ResponsiblePersonnelId |
Gets or sets the responsible personnel identifier. |
string |
Required if EMRSystem = Meditech, or Cerner |
| MedicationOrderBasis |
Gets or sets the medication order basis. |
string |
None. |
| DepartmentId |
Gets or sets the department identifier. |
string |
Required if EMRSystem = Meditech |
| SiteId |
Gets or sets the site identifier. |
string |
Required if EMRSystem = Meditech |
| CategoryId |
Gets or sets the category identifier. |
string |
Required if EMRSystem = Meditech |
| ProcedureId |
Gets or sets the procedure identifier. |
string |
Required if EMRSystem = Meditech |
| ProcedureIdType |
Gets or sets the procedure identifier type. |
string |
None. |
| OrderPriorityId |
Gets or sets the order priority identifier. |
string |
Required if EMRSystem = Meditech |
| TechnologistId |
Gets or sets the technologist identifier. |
string |
Required if EMRSystem = Meditech |
| ServiceDateTime |
Gets or sets the Service Date Time. |
datetime |
Required if EMRSystem = Meditech |
| OrderFields |
Gets or sets the OrderFields object. |
Collection of OrderFieldInput |
None. |
| CopyResultTo |
Gets or sets the CopyResultTo object. |
Collection of OrderCreateCopyResultTo |
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",
"PatientIdType": "sample string 3",
"EncounterId": "sample string 4",
"EncounterIdType": "sample string 5",
"OrderableCodeId": "sample string 6",
"ResponsiblePersonnelId": "sample string 7",
"MedicationOrderBasis": "sample string 8",
"DepartmentId": "sample string 9",
"SiteId": "sample string 10",
"CategoryId": "sample string 11",
"ProcedureId": "sample string 12",
"ProcedureIdType": "sample string 13",
"OrderPriorityId": "sample string 14",
"TechnologistId": "sample string 15",
"ServiceDateTime": "2025-12-12T21:08:11.9965947+00:00",
"OrderFields": [
{
"Id": "sample string 1",
"Values": [
"sample string 1",
"sample string 2"
]
},
{
"Id": "sample string 1",
"Values": [
"sample string 1",
"sample string 2"
]
}
],
"CopyResultTo": [
{
"Address1": "sample string 1",
"Address2": "sample string 2",
"Address3": "sample string 3",
"EmailAddress": "sample string 4",
"FaxNumber": "sample string 5",
"IsDraft": true,
"IsLetter": true,
"IsQuestionnaire": true,
"IsSigned": true,
"PhoneNumber": "sample string 10",
"ProviderId": "sample string 11"
},
{
"Address1": "sample string 1",
"Address2": "sample string 2",
"Address3": "sample string 3",
"EmailAddress": "sample string 4",
"FaxNumber": "sample string 5",
"IsDraft": true,
"IsLetter": true,
"IsQuestionnaire": true,
"IsSigned": true,
"PhoneNumber": "sample string 10",
"ProviderId": "sample string 11"
}
],
"LoginId": "sample string 17",
"Password": "sample string 18",
"EmrInstance": "sample string 19",
"ApplicationName": "sample string 20",
"ApplicationKey": null,
"AuthorizationToken": "sample string 22",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmProposedOrderCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ProposedOrderId |
Gets or sets the order identifier. |
string |
None. |
| AlternativeIdentifiers |
Gets or sets the alternative identifiers of the created order. |
Collection of Identity |
None. |
Response Codes
Http Status Code 201 - Indicates that the requested record was successfully created.
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
{
"ProposedOrderId": "sample string 1",
"AlternativeIdentifiers": [
{
"Code": "sample string 1",
"Description": "sample string 2",
"Value": "sample string 3"
},
{
"Code": "sample string 1",
"Description": "sample string 2",
"Value": "sample string 3"
}
]
}