POST Messages

Developer Tools

POST api/v1/{EMRSystem}/Messages

Creates (sends) a new Message.

HTTP Method

POST

Applicable Emissary Products

Interactive Workflow

Allscripts

In Dev

Athena

In Dev

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 message create request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

UserId

Gets or sets the user identifier.

string

Required

MessageTypeId

Gets or sets the message type identifier.

string

None.

Recipients

Gets or sets the message recipients.

Collection of MessageSendRecipientViewModel

None.

Subject

Gets or sets the message subject.

string

None.

MessageText

Gets or sets the message text.

string

None.

MessageTextFormat

Gets or sets the message text format.

string

None.

Priority

Gets or sets the message priority.

string

None.

SendDate

Gets or sets the message send date/time.

date

None.

PatientId

Gets or sets the patient identifier.

string

None.

 

Response Information

 
Resource Description
Http response containing newly created Message 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 – Returns Sansoro.Shared.SansoroServiceBus.Models.MessageCreateResponseViewModel

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",
  "MessageTypeId": "sample string 2",
  "Recipients": [
    {
      "RecipientType": "sample string 1",
      "RecipientId": "sample string 2",
      "CC": true
    },
    {
      "RecipientType": "sample string 1",
      "RecipientId": "sample string 2",
      "CC": true
    }
  ],
  "Subject": "sample string 3",
  "MessageText": "sample string 4",
  "MessageTextFormat": "sample string 5",
  "Priority": "sample string 6",
  "SendDate": "2018-02-14T16:58:48.838997Z",
  "PatientId": "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
<MessageCreateRequestViewModel 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>
  <MessageText>sample string 4</MessageText>
  <MessageTextFormat>sample string 5</MessageTextFormat>
  <MessageTypeId>sample string 2</MessageTypeId>
  <PatientId>sample string 7</PatientId>
  <Priority>sample string 6</Priority>
  <Recipients xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:MessageSendRecipientViewModel>
      <d2p1:CC>true</d2p1:CC>
      <d2p1:RecipientId>sample string 2</d2p1:RecipientId>
      <d2p1:RecipientType>sample string 1</d2p1:RecipientType>
    </d2p1:MessageSendRecipientViewModel>
    <d2p1:MessageSendRecipientViewModel>
      <d2p1:CC>true</d2p1:CC>
      <d2p1:RecipientId>sample string 2</d2p1:RecipientId>
      <d2p1:RecipientType>sample string 1</d2p1:RecipientType>
    </d2p1:MessageSendRecipientViewModel>
  </Recipients>
  <SendDate>2018-02-14T10:58:48.838997-06:00</SendDate>
  <Subject>sample string 3</Subject>
  <UserId>sample string 1</UserId>
</MessageCreateRequestViewModel>

Submit a Comment

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

 

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