POST Patient Messages

Developer Tools

POST api/v1/{EMRSystem}/PatientMessages

Creates (sends) a new Patient Message.

HTTP Method

POST

Applicable Emissary Products

Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

In Dev

Meditech

In Dev

Sandbox

In Dev

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

Request Information

URI Parameters

One of the following parameters must have a value specified: MessageType, ReplyToMessage

One of the following parameters must have a value specified: ReplyToMessage, SubjectId, Subject

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

 
Body Parameters
The patient message create request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

UserId

Gets or sets the user identifier.

string

Required

PatientId

Gets or sets the patient identifier.

string

Required

To

Gets or sets the patient message To identifier.

string

Required

MessageType

Gets or sets the patient message type.

string

None.

ReplyToMessage

Gets or sets the Reply To Message identifier.

string

None.

SubjectId

Gets or sets the patient message subject identifier.

string

None.

Subject

Gets or sets the free text patient message subject.

string

None.

Body

Gets or sets the patient message body.

Collection of string

None.

 

Response Information

 
Resource Description
Http response containing newly created Patient 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.PatentMessageCreateResponseViewModel

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",
  "To": "sample string 3",
  "MessageType": "sample string 4",
  "ReplyToMessage": "sample string 5",
  "SubjectId": "sample string 6",
  "Subject": "sample string 7",
  "Body": [
    "sample string 1",
    "sample string 2"
  ],
  "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
<PatientMessageCreateRequestViewModel 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>
  <Body xmlns:d2p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Body>
  <MessageType>sample string 4</MessageType>
  <PatientId>sample string 2</PatientId>
  <ReplyToMessage>sample string 5</ReplyToMessage>
  <Subject>sample string 7</Subject>
  <SubjectId>sample string 6</SubjectId>
  <To>sample string 3</To>
  <UserId>sample string 1</UserId>
</PatientMessageCreateRequestViewModel>

Submit a Comment

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

 

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