GET api/v1/{EMRSystem}/MedicationOrders/Discovery
Returns the Medication Orderables
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets the user identifier. |
string |
Required |
| SearchString |
Gets or sets the SearchString |
string |
None. |
| MedicationId |
Gets or sets the MedicationId to search for |
string |
None. |
| SearchCode |
Gets or sets the SearchCode |
string |
None. |
| CodingSystem |
Gets or sets the CodingSystem that is needed to use with SearchCode |
string |
None. |
| FormularyOnly |
Gets or sets if only want Formulary Meds |
boolean |
None. |
| AdHocMedSearch |
Gets or sets to use AdhocMed search, Search String required |
boolean |
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
UdmMedicationOrdersDiscoveryResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| MedicationOrderables |
gets or sets the list of Medication Orderables |
Collection of MedicationOrderable |
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
{
"MedicationOrderables": [
{
"MedicationId": "sample string 1",
"MedicationName": "sample string 2",
"OrderDetailId": "sample string 3",
"OrderableCode": "sample string 4",
"OrderableCodeDesc": "sample string 5",
"MedicationOrderableItems": [
{
"MedicationItemId": "sample string 1",
"MedicationGenericName": "sample string 2",
"MedicationBrandName": "sample string 3",
"MedicationDescription": "sample string 4",
"NDC": "sample string 5",
"Form": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Strength": "sample string 6",
"StrengthUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Volume": "sample string 7",
"VolumeUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OnFormulary": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"MedicationProductId": "sample string 8",
"ManufacturerItemId": "sample string 9",
"ManufacturerName": "sample string 10"
},
{
"MedicationItemId": "sample string 1",
"MedicationGenericName": "sample string 2",
"MedicationBrandName": "sample string 3",
"MedicationDescription": "sample string 4",
"NDC": "sample string 5",
"Form": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Strength": "sample string 6",
"StrengthUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Volume": "sample string 7",
"VolumeUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OnFormulary": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"MedicationProductId": "sample string 8",
"ManufacturerItemId": "sample string 9",
"ManufacturerName": "sample string 10"
}
]
},
{
"MedicationId": "sample string 1",
"MedicationName": "sample string 2",
"OrderDetailId": "sample string 3",
"OrderableCode": "sample string 4",
"OrderableCodeDesc": "sample string 5",
"MedicationOrderableItems": [
{
"MedicationItemId": "sample string 1",
"MedicationGenericName": "sample string 2",
"MedicationBrandName": "sample string 3",
"MedicationDescription": "sample string 4",
"NDC": "sample string 5",
"Form": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Strength": "sample string 6",
"StrengthUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Volume": "sample string 7",
"VolumeUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OnFormulary": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"MedicationProductId": "sample string 8",
"ManufacturerItemId": "sample string 9",
"ManufacturerName": "sample string 10"
},
{
"MedicationItemId": "sample string 1",
"MedicationGenericName": "sample string 2",
"MedicationBrandName": "sample string 3",
"MedicationDescription": "sample string 4",
"NDC": "sample string 5",
"Form": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Strength": "sample string 6",
"StrengthUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Volume": "sample string 7",
"VolumeUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OnFormulary": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"MedicationProductId": "sample string 8",
"ManufacturerItemId": "sample string 9",
"ManufacturerName": "sample string 10"
}
]
}
]
}