POST Medication Orders

Developer Tools

POST api/v1/{EMRSystem}/MedicationOrders

Creates a Historical Medication Order.

HTTP Method

POST

Applicable Emissary Products

Interactive Workflow

Allscripts

Released

Athena

Released

Cerner

Released

Meditech

In Dev

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

 
Body Parameters
The medication order create request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

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

None.

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

date

None.

StopDateTime

The date the medication was stopped

date

None.

MedicationComments

Additional medication information

string

None.

 

Response Information

 
Resource Description
Http response containing newly created Medication Order Id.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

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.

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
Sample Message
Download Json Schema
{
  "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": "2018-01-27T20:08:12.9127952Z",
  "StopDateTime": "2018-01-27T20:08:12.9127952Z",
  "MedicationComments": "sample string 7",
  "Domain": "sample string 8",
  "LoginId": "sample string 9",
  "Password": "sample string 10",
  "EmrInstance": "sample string 11",
  "ApplicationName": "sample string 12",
  "ApplicationKey": "sample string 13"
}
Sample Message
<MedicationOrderCreateRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 13</ApplicationKey>
  <ApplicationName>sample string 12</ApplicationName>
  <Domain>sample string 8</Domain>
  <EmrInstance>sample string 11</EmrInstance>
  <LoginId>sample string 9</LoginId>
  <Password>sample string 10</Password>
  <AdminInstructions>sample string 5</AdminInstructions>
  <EncounterId>sample string 3</EncounterId>
  <MedicationComments>sample string 7</MedicationComments>
  <MedicationId>sample string 4</MedicationId>
  <PatientId>sample string 2</PatientId>
  <ProviderId>sample string 6</ProviderId>
  <StartDateTime>2018-01-13T01:05:13.8217276-06:00</StartDateTime>
  <StopDateTime>2018-01-13T01:05:13.8217276-06:00</StopDateTime>
  <UserId>sample string 1</UserId>
</MedicationOrderCreateRequestViewModel>
>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?