GET Message Recipients

Developer Tools

GET api/v1/{EMRSystem}/PatientMessageRecipients

Returns the available Patient Message Recipients for a given user and patient.

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

UserId

Gets or sets the user identifier.

string

Required

PatientId

Gets or sets the patient identifier.

string

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a list of Patient Message Recipients.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

IsOutOfContact

Gets or sets Out Of Contact status.

boolean

None.

IsPCP

Gets or sets the Is PCP property.

boolean

None.

OutOfContactEndDate

Gets or sets the Out Of Contact End DateTime.

date

None.

PCPType

Gets or sets the PCP Type.

CodedObjectViewModel

None.

RecipientId

Gets or sets the Recipient Identifier.

string

None.

RecipientName

Gets or sets the Recipient Name.

string

None.

 
Response Codes

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

Http Status Code 204 – Indicates that there were Zero records found.

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
[
  {
    "IsOutOfContact": true,
    "IsPCP": true,
    "OutOfContactEndDate": "2018-02-14T20:08:03.026589Z",
    "PCPType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "RecipientId": "sample string 1",
    "RecipientName": "sample string 2"
  },
  {
    "IsOutOfContact": true,
    "IsPCP": true,
    "OutOfContactEndDate": "2018-02-14T20:08:03.026589Z",
    "PCPType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "RecipientId": "sample string 1",
    "RecipientName": "sample string 2"
  }
]
Sample Message
<ArrayOfPatientMessageRecipientViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
  <PatientMessageRecipientViewModel>
    <IsOutOfContact>true</IsOutOfContact>
    <IsPCP>true</IsPCP>
    <OutOfContactEndDate>2018-02-14T14:08:03.026589-06:00</OutOfContactEndDate>
    <PCPType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </PCPType>
    <RecipientId>sample string 1</RecipientId>
    <RecipientName>sample string 2</RecipientName>
  </PatientMessageRecipientViewModel>
  <PatientMessageRecipientViewModel>
    <IsOutOfContact>true</IsOutOfContact>
    <IsPCP>true</IsPCP>
    <OutOfContactEndDate>2018-02-14T14:08:03.026589-06:00</OutOfContactEndDate>
    <PCPType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </PCPType>
    <RecipientId>sample string 1</RecipientId>
    <RecipientName>sample string 2</RecipientName>
  </PatientMessageRecipientViewModel>
</ArrayOfPatientMessageRecipientViewModel>

Submit a Comment

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

 

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