GET Messages by Id

Developer Tools

GET api/v1/{EMRSystem}/Messages/{MessageId}

Returns a single message given a message ID.

HTTP Method

GET

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

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

MessageId

The message identifier.

string

Required

UserId

Gets or sets the user identifier.

string

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a single Message.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

MessageFormat

Gets or sets the message format.

string

None.

Body

Gets or sets the message body.

string

None.

MessageId

Gets or sets the message identifier.

string

None.

MessageDateTime

Gets or sets the message date/time.

date

None.

Recipients

Gets or sets the recipients.

Collection of MessageRecipientViewModel

None.

SenderType

Gets or sets the sender type.

string

None.

SenderId

Gets or sets the sender identifier.

string

None.

SenderName

Gets or sets the sender name.

string

None.

FolderId

Gets or sets the folder identifier.

string

None.

FolderName

Gets or sets the folder name.

string

None.

PatientId

Gets or sets the patient identifier.

string

None.

PatientName

Gets or sets the patient name.

string

None.

EncounterId

Gets or sets the encounter identifier.

string

None.

Orders

Gets or sets the orders.

Collection of string

None.

Status

Gets or sets the message status.

CodedObjectViewModel

None.

Priority

Gets or sets the message priority.

CodedObjectViewModel

None.

EncounterType

Gets or sets the encounter type.

CodedObjectViewModel

None.

PatientClass

Gets or sets the patient class.

CodedObjectViewModel

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.MessageResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

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
{
  "MessageFormat": "sample string 1",
  "Body": "sample string 2",
  "MessageId": "sample string 3",
  "MessageDateTime": "2018-02-14T17:03:35.6157362Z",
  "Recipients": [
    {
      "RecipientType": "sample string 1",
      "RecipientId": "sample string 2",
      "RecipientName": "sample string 3"
    },
    {
      "RecipientType": "sample string 1",
      "RecipientId": "sample string 2",
      "RecipientName": "sample string 3"
    }
  ],
  "SenderType": "sample string 4",
  "SenderId": "sample string 5",
  "SenderName": "sample string 6",
  "FolderId": "sample string 7",
  "FolderName": "sample string 8",
  "PatientId": "sample string 9",
  "PatientName": "sample string 10",
  "EncounterId": "sample string 11",
  "Orders": [
    "sample string 1",
    "sample string 2"
  ],
  "Status": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "Priority": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "EncounterType": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "PatientClass": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  }
}
Sample Message
<MessageResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <EncounterId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 11</EncounterId>
  <EncounterType xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </EncounterType>
  <FolderId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 7</FolderId>
  <FolderName xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 8</FolderName>
  <MessageDateTime xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">2018-02-14T11:03:35.6157362-06:00</MessageDateTime>
  <MessageId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 3</MessageId>
  <Orders xmlns:d2p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Orders>
  <PatientClass xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </PatientClass>
  <PatientId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 9</PatientId>
  <PatientName xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 10</PatientName>
  <Priority xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </Priority>
  <Recipients xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <MessageRecipientViewModel>
      <RecipientId>sample string 2</RecipientId>
      <RecipientName>sample string 3</RecipientName>
      <RecipientType>sample string 1</RecipientType>
    </MessageRecipientViewModel>
    <MessageRecipientViewModel>
      <RecipientId>sample string 2</RecipientId>
      <RecipientName>sample string 3</RecipientName>
      <RecipientType>sample string 1</RecipientType>
    </MessageRecipientViewModel>
  </Recipients>
  <SenderId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 5</SenderId>
  <SenderName xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 6</SenderName>
  <SenderType xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 4</SenderType>
  <Status xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </Status>
  <Body>sample string 2</Body>
  <MessageFormat>sample string 1</MessageFormat>
</MessageResponseViewModel>

Submit a Comment

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

 

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