GET Patient Messages by Id

Developer Tools

GET api/v1/{EMRSystem}/PatientMessages/{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 Patient Message.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

Attachments

Gets or sets the attachments.

Collection of AttachmentViewModel

None.

CanBeRepliedTo

Gets or sets the can be replied to.

boolean

None.

NoReplyReason

Gets or sets the no reply reason.

string

None.

PatientTasks

Gets or sets the patient tasks.

Collection of PatientTaskViewModel

None.

Viewers

Gets or sets the viewers.

Collection of ViewerViewModel

None.

ParentMessageId

Gets or sets the parent message identifier.

string

None.

MessageId

Gets or sets the message identifier.

string

None.

PatientId

Gets or sets the patient identifier.

string

None.

EncounterId

Gets or sets the encounter identifier.

string

None.

EncounterType

Gets or sets the encounter type.

CodedObjectViewModel

None.

PatientClass

Gets or sets the patient class.

CodedObjectViewModel

None.

MessageType

Gets or sets the type of the message.

CodedObjectViewModel

None.

Subject

Gets or sets the subject.

string

None.

Body

Gets or sets the body.

string

None.

From

Gets or sets from.

FromViewModel

None.

To

Gets or sets to.

ToViewModel

None.

HasAttachment

Gets or sets the has attachment.

boolean

None.

HasIncompleteTask

Gets or sets the has incomplete task.

boolean

None.

MessageDateTime

Gets or sets the message date time.

date

None.

Read

Gets or sets the read.

boolean

None.

 
Response Codes

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

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
{
  "Attachments": [
    {
      "AttachmentId": "sample string 1",
      "AttachmentName": "sample string 2",
      "Text": "sample string 3",
      "TextFormat": "sample string 4"
    },
    {
      "AttachmentId": "sample string 1",
      "AttachmentName": "sample string 2",
      "Text": "sample string 3",
      "TextFormat": "sample string 4"
    }
  ],
  "CanBeRepliedTo": true,
  "NoReplyReason": "sample string 1",
  "PatientTasks": [
    {
      "CompletedDateTime": "2018-02-14T19:57:12.382939Z",
      "IsComplete": true,
      "TaskId": "sample string 1",
      "TaskName": "sample string 2",
      "TaskType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "CompletedDateTime": "2018-02-14T19:57:12.382939Z",
      "IsComplete": true,
      "TaskId": "sample string 1",
      "TaskName": "sample string 2",
      "TaskType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "Viewers": [
    {
      "HasRead": true,
      "ReadDateTime": "2018-02-14T19:57:12.382939Z",
      "ViewerId": "sample string 1",
      "ViewerName": "sample string 2"
    },
    {
      "HasRead": true,
      "ReadDateTime": "2018-02-14T19:57:12.382939Z",
      "ViewerId": "sample string 1",
      "ViewerName": "sample string 2"
    }
  ],
  "ParentMessageId": "sample string 2",
  "MessageId": "sample string 3",
  "PatientId": "sample string 4",
  "EncounterId": "sample string 5",
  "EncounterType": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "PatientClass": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "MessageType": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "Subject": "sample string 6",
  "Body": "sample string 7",
  "From": {
    "SenderId": "sample string 1",
    "SenderName": "sample string 2"
  },
  "To": {
    "RecipientId": "sample string 1",
    "RecipientName": "sample string 2"
  },
  "HasAttachment": true,
  "HasIncompleteTask": true,
  "MessageDateTime": "2018-02-14T19:57:12.382939Z",
  "Read": true
}
Sample Message
<PatientMessageResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <Body xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 7</Body>
  <EncounterId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 5</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>
  <From xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <SenderId>sample string 1</SenderId>
    <SenderName>sample string 2</SenderName>
  </From>
  <HasAttachment xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">true</HasAttachment>
  <HasIncompleteTask xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">true</HasIncompleteTask>
  <MessageDateTime xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">2018-02-14T13:57:12.382939-06:00</MessageDateTime>
  <MessageId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 3</MessageId>
  <MessageType xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </MessageType>
  <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 4</PatientId>
  <Read xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">true</Read>
  <Subject xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 6</Subject>
  <To xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <RecipientId>sample string 1</RecipientId>
    <RecipientName>sample string 2</RecipientName>
  </To>
  <Attachments xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:AttachmentViewModel>
      <d2p1:AttachmentId>sample string 1</d2p1:AttachmentId>
      <d2p1:AttachmentName>sample string 2</d2p1:AttachmentName>
      <d2p1:Text>sample string 3</d2p1:Text>
      <d2p1:TextFormat>sample string 4</d2p1:TextFormat>
    </d2p1:AttachmentViewModel>
    <d2p1:AttachmentViewModel>
      <d2p1:AttachmentId>sample string 1</d2p1:AttachmentId>
      <d2p1:AttachmentName>sample string 2</d2p1:AttachmentName>
      <d2p1:Text>sample string 3</d2p1:Text>
      <d2p1:TextFormat>sample string 4</d2p1:TextFormat>
    </d2p1:AttachmentViewModel>
  </Attachments>
  <CanBeRepliedTo>true</CanBeRepliedTo>
  <NoReplyReason>sample string 1</NoReplyReason>
  <ParentMessageId>sample string 2</ParentMessageId>
  <PatientTasks xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:PatientTaskViewModel>
      <d2p1:CompletedDateTime>2018-02-14T13:57:12.382939-06:00</d2p1:CompletedDateTime>
      <d2p1:IsComplete>true</d2p1:IsComplete>
      <d2p1:TaskId>sample string 1</d2p1:TaskId>
      <d2p1:TaskName>sample string 2</d2p1:TaskName>
      <d2p1:TaskType>
        <d2p1:Id>sample string 1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:TaskType>
    </d2p1:PatientTaskViewModel>
    <d2p1:PatientTaskViewModel>
      <d2p1:CompletedDateTime>2018-02-14T13:57:12.382939-06:00</d2p1:CompletedDateTime>
      <d2p1:IsComplete>true</d2p1:IsComplete>
      <d2p1:TaskId>sample string 1</d2p1:TaskId>
      <d2p1:TaskName>sample string 2</d2p1:TaskName>
      <d2p1:TaskType>
        <d2p1:Id>sample string 1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:TaskType>
    </d2p1:PatientTaskViewModel>
  </PatientTasks>
  <Viewers xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:ViewerViewModel>
      <d2p1:HasRead>true</d2p1:HasRead>
      <d2p1:ReadDateTime>2018-02-14T13:57:12.382939-06:00</d2p1:ReadDateTime>
      <d2p1:ViewerId>sample string 1</d2p1:ViewerId>
      <d2p1:ViewerName>sample string 2</d2p1:ViewerName>
    </d2p1:ViewerViewModel>
    <d2p1:ViewerViewModel>
      <d2p1:HasRead>true</d2p1:HasRead>
      <d2p1:ReadDateTime>2018-02-14T13:57:12.382939-06:00</d2p1:ReadDateTime>
      <d2p1:ViewerId>sample string 1</d2p1:ViewerId>
      <d2p1:ViewerName>sample string 2</d2p1:ViewerName>
    </d2p1:ViewerViewModel>
  </Viewers>
</PatientMessageResponseViewModel>

Submit a Comment

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

 

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